Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-non-employee-source) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | Source Id + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +### Return type +[**NonEmployeeSource**](../models/non-employee-source) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A patched non-employee source object. | NonEmployeeSource | - | +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 | - | +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-patch+json + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation +from sailpoint.v2024.models.non_employee_source import NonEmployeeSource +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + source_id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id # str | Source Id + json_patch_operation = '''[{op=replace, path=/name, value={new name=null}}, {op=replace, path=/approvers, value=[2c91809f703bb37a017040a2fe8748c7, 48b1f463c9e8427db5a5071bd81914b8]}]''' # List[JsonPatchOperation] | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + try: + # Patch a Non-Employee Source + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_source(source_id=source_id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_source(source_id, new_json_patch_operation) + print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_source:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_source: %s\n" % e) +``` + + + +[[Back to top]](#) + +## reject-non-employee-request +Reject a Non-Employee Request +This endpoint will reject an approval item request and notify user. The current user must be the requested approver. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/reject-non-employee-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Non-Employee approval item id (UUID) + Body | non_employee_reject_approval_decision | [**NonEmployeeRejectApprovalDecision**](../models/non-employee-reject-approval-decision) | True | + +### Return type +[**NonEmployeeApprovalItem**](../models/non-employee-approval-item) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Non-Employee approval item object. | NonEmployeeApprovalItem | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.non_employee_approval_item import NonEmployeeApprovalItem +from sailpoint.v2024.models.non_employee_reject_approval_decision import NonEmployeeRejectApprovalDecision +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'e136567de87e4d029e60b3c3c55db56d' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) + non_employee_reject_approval_decision = '''{ + "comment" : "approved" + }''' # NonEmployeeRejectApprovalDecision | + + try: + # Reject a Non-Employee Request + new_non_employee_reject_approval_decision = NonEmployeeRejectApprovalDecision.from_json(non_employee_reject_approval_decision) + results = NonEmployeeLifecycleManagementApi(api_client).reject_non_employee_request(id=id, non_employee_reject_approval_decision=new_non_employee_reject_approval_decision) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).reject_non_employee_request(id, new_non_employee_reject_approval_decision) + print("The response of NonEmployeeLifecycleManagementApi->reject_non_employee_request:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->reject_non_employee_request: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-non-employee-record +Update Non-Employee Record +This request will update a non-employee record. There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:update`, in which case they +update all available fields. + 2. The user is owner of the source, in this case they can only update the +end date. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-non-employee-record) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Non-employee record id (UUID) + Body | non_employee_request_body | [**NonEmployeeRequestBody**](../models/non-employee-request-body) | True | Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + +### Return type +[**NonEmployeeRecord**](../models/non-employee-record) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | An updated non-employee record. | NonEmployeeRecord | - | +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 + +```python +from sailpoint.v2024.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.non_employee_record import NonEmployeeRecord +from sailpoint.v2024.models.non_employee_request_body import NonEmployeeRequestBody +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-employee record id (UUID) # str | Non-employee record id (UUID) + non_employee_request_body = '''{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + }''' # NonEmployeeRequestBody | Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + + try: + # Update Non-Employee Record + new_non_employee_request_body = NonEmployeeRequestBody.from_json(non_employee_request_body) + results = NonEmployeeLifecycleManagementApi(api_client).update_non_employee_record(id=id, non_employee_request_body=new_non_employee_request_body) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).update_non_employee_record(id, new_non_employee_request_body) + print("The response of NonEmployeeLifecycleManagementApi->update_non_employee_record:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->update_non_employee_record: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/NotificationsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/NotificationsApi.md new file mode 100644 index 000000000..bc1ec9856 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/NotificationsApi.md @@ -0,0 +1,1158 @@ +--- +id: v2024-notifications +title: Notifications +pagination_label: Notifications +sidebar_label: Notifications +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Notifications', 'V2024Notifications'] +slug: /tools/sdk/python/v2024/methods/notifications +tags: ['SDK', 'Software Development Kit', 'Notifications', 'V2024Notifications'] +--- + +# sailpoint.v2024.NotificationsApi + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-domain-dkim**](#create-domain-dkim) | **POST** `/verified-domains` | Verify domain address via DKIM +[**create-notification-template**](#create-notification-template) | **POST** `/notification-templates` | Create Notification Template +[**create-verified-from-address**](#create-verified-from-address) | **POST** `/verified-from-addresses` | Create Verified From Address +[**delete-notification-templates-in-bulk**](#delete-notification-templates-in-bulk) | **POST** `/notification-templates/bulk-delete` | Bulk Delete Notification Templates +[**delete-verified-from-address**](#delete-verified-from-address) | **DELETE** `/verified-from-addresses/{id}` | Delete Verified From Address +[**get-dkim-attributes**](#get-dkim-attributes) | **GET** `/verified-domains` | Get DKIM Attributes +[**get-mail-from-attributes**](#get-mail-from-attributes) | **GET** `/mail-from-attributes/{identity}` | Get MAIL FROM Attributes +[**get-notification-template**](#get-notification-template) | **GET** `/notification-templates/{id}` | Get Notification Template By Id +[**get-notifications-template-context**](#get-notifications-template-context) | **GET** `/notification-template-context` | Get Notification Template Context +[**list-from-addresses**](#list-from-addresses) | **GET** `/verified-from-addresses` | List From Addresses +[**list-notification-preferences**](#list-notification-preferences) | **GET** `/notification-preferences/{key}` | List Notification Preferences for tenant. +[**list-notification-template-defaults**](#list-notification-template-defaults) | **GET** `/notification-template-defaults` | List Notification Template Defaults +[**list-notification-templates**](#list-notification-templates) | **GET** `/notification-templates` | List Notification Templates +[**put-mail-from-attributes**](#put-mail-from-attributes) | **PUT** `/mail-from-attributes` | Change MAIL FROM domain +[**send-test-notification**](#send-test-notification) | **POST** `/send-test-notification` | Send Test Notification + + +## create-domain-dkim +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +Verify domain address via DKIM +Create a domain to be verified via DKIM (DomainKeys Identified Mail) + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-domain-dkim) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Body | domain_address | [**DomainAddress**](../models/domain-address) | True | + +### Return type +[**DomainStatusDto**](../models/domain-status-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of DKIM tokens required for the verification process. | DomainStatusDto | - | +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 | - | +405 | Method Not Allowed - indicates that the server knows the request method, but the target resource doesn't support this method. | CreateDomainDkim405Response | - | +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 + +```python +from sailpoint.v2024.api.notifications_api import NotificationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.domain_address import DomainAddress +from sailpoint.v2024.models.domain_status_dto import DomainStatusDto +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + domain_address = '''{ + "domain" : "sailpoint.com" + }''' # DomainAddress | + + try: + # Verify domain address via DKIM + new_domain_address = DomainAddress.from_json(domain_address) + results = NotificationsApi(api_client).create_domain_dkim(x_sail_point_experimental=x_sail_point_experimental, domain_address=new_domain_address) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).create_domain_dkim(x_sail_point_experimental, new_domain_address) + print("The response of NotificationsApi->create_domain_dkim:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NotificationsApi->create_domain_dkim: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-notification-template +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +Create Notification Template +This creates a template for your site. + +You can also use this endpoint to update a template. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-notification-template) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Body | template_dto | [**TemplateDto**](../models/template-dto) | True | + +### Return type +[**TemplateDto**](../models/template-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A template object for your site | TemplateDto | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.notifications_api import NotificationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.template_dto import TemplateDto +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + template_dto = '''{ + "slackTemplate" : "slackTemplate", + "footer" : "footer", + "teamsTemplate" : "teamsTemplate", + "subject" : "You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.", + "created" : "2020-01-01T00:00:00Z", + "description" : "Daily digest - sent if number of outstanding tasks for task owner > 0", + "medium" : "EMAIL", + "locale" : "en", + "body" : "Please go to the task manager", + "name" : "Task Manager Subscription", + "replyTo" : "$__global.emailFromAddress", + "header" : "header", + "modified" : "2020-01-01T00:00:00Z", + "from" : "$__global.emailFromAddress", + "id" : "c17bea3a-574d-453c-9e04-4365fbf5af0b", + "key" : "cloud_manual_work_item_summary" + }''' # TemplateDto | + + try: + # Create Notification Template + new_template_dto = TemplateDto.from_json(template_dto) + results = NotificationsApi(api_client).create_notification_template(x_sail_point_experimental=x_sail_point_experimental, template_dto=new_template_dto) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).create_notification_template(x_sail_point_experimental, new_template_dto) + print("The response of NotificationsApi->create_notification_template:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NotificationsApi->create_notification_template: %s\n" % e) +``` + + + +[[Back to top]](#) + +## create-verified-from-address +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +Create Verified From Address +Create a new sender email address and initiate verification process. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-verified-from-address) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Body | email_status_dto | [**EmailStatusDto**](../models/email-status-dto) | True | + +### Return type +[**EmailStatusDto**](../models/email-status-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | New Verified Email Status | EmailStatusDto | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.notifications_api import NotificationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.email_status_dto import EmailStatusDto +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + email_status_dto = '''{ + "isVerifiedByDomain" : false, + "verificationStatus" : "PENDING", + "id" : "id", + "email" : "sender@example.com" + }''' # EmailStatusDto | + + try: + # Create Verified From Address + new_email_status_dto = EmailStatusDto.from_json(email_status_dto) + results = NotificationsApi(api_client).create_verified_from_address(x_sail_point_experimental=x_sail_point_experimental, email_status_dto=new_email_status_dto) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).create_verified_from_address(x_sail_point_experimental, new_email_status_dto) + print("The response of NotificationsApi->create_verified_from_address:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NotificationsApi->create_verified_from_address: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-notification-templates-in-bulk +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +Bulk Delete Notification Templates +This lets you bulk delete templates that you previously created for your site. Since this is a beta feature, please contact support to enable usage. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-notification-templates-in-bulk) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Body | template_bulk_delete_dto | [**[]TemplateBulkDeleteDto**](../models/template-bulk-delete-dto) | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +204 | No content - indicates the request was successful but there is no content to be returned in the response. | | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.notifications_api import NotificationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.template_bulk_delete_dto import TemplateBulkDeleteDto +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + template_bulk_delete_dto = '''[sailpoint.v2024.TemplateBulkDeleteDto()]''' # List[TemplateBulkDeleteDto] | + + try: + # Bulk Delete Notification Templates + new_template_bulk_delete_dto = TemplateBulkDeleteDto.from_json(template_bulk_delete_dto) + NotificationsApi(api_client).delete_notification_templates_in_bulk(x_sail_point_experimental=x_sail_point_experimental, template_bulk_delete_dto=new_template_bulk_delete_dto) + # Below is a request that includes all optional parameters + # NotificationsApi(api_client).delete_notification_templates_in_bulk(x_sail_point_experimental, new_template_bulk_delete_dto) + except Exception as e: + print("Exception when calling NotificationsApi->delete_notification_templates_in_bulk: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-verified-from-address +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +Delete Verified From Address +Delete a verified sender email address + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-verified-from-address) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +204 | No content - indicates the request was successful but there is no content to be returned in the response. | | - | +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 + +```python +from sailpoint.v2024.api.notifications_api import NotificationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + id = 'id_example' # str | # str | + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + + try: + # Delete Verified From Address + + NotificationsApi(api_client).delete_verified_from_address(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # NotificationsApi(api_client).delete_verified_from_address(id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling NotificationsApi->delete_verified_from_address: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-dkim-attributes +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +Get DKIM Attributes +Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants' AWS SES identities. Limits retrieval to 100 identities per call. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-dkim-attributes) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**List[DkimAttributes]**](../models/dkim-attributes) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of DKIM Attributes | List[DkimAttributes] | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.notifications_api import NotificationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.dkim_attributes import DkimAttributes +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + + try: + # Get DKIM Attributes + + results = NotificationsApi(api_client).get_dkim_attributes(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).get_dkim_attributes(x_sail_point_experimental) + print("The response of NotificationsApi->get_dkim_attributes:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NotificationsApi->get_dkim_attributes: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-mail-from-attributes +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +Get MAIL FROM Attributes +Retrieve MAIL FROM attributes for a given AWS SES identity. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-mail-from-attributes) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | id | **str** | True | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**MailFromAttributes**](../models/mail-from-attributes) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | MAIL FROM Attributes object | MailFromAttributes | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.notifications_api import NotificationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.mail_from_attributes import MailFromAttributes +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + id = 'bobsmith@sailpoint.com' # str | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status # str | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + + try: + # Get MAIL FROM Attributes + + results = NotificationsApi(api_client).get_mail_from_attributes(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).get_mail_from_attributes(id, x_sail_point_experimental) + print("The response of NotificationsApi->get_mail_from_attributes:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NotificationsApi->get_mail_from_attributes: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-notification-template +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +Get Notification Template By Id +This gets a template that you have modified for your site by Id. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-notification-template) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Id of the Notification Template + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**TemplateDto**](../models/template-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A template object for your site | TemplateDto | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.notifications_api import NotificationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.template_dto import TemplateDto +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Notification Template # str | Id of the Notification Template + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + + try: + # Get Notification Template By Id + + results = NotificationsApi(api_client).get_notification_template(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).get_notification_template(id, x_sail_point_experimental) + print("The response of NotificationsApi->get_notification_template:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NotificationsApi->get_notification_template: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-notifications-template-context +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +Get Notification Template Context +The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called "Global Context" (a.k.a. notification template context). It defines a set of attributes + that will be available per tenant (organization). + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-notifications-template-context) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**NotificationTemplateContext**](../models/notification-template-context) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Notification template context attributes for a specific tenant. | NotificationTemplateContext | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.notifications_api import NotificationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.notification_template_context import NotificationTemplateContext +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + + try: + # Get Notification Template Context + + results = NotificationsApi(api_client).get_notifications_template_context(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).get_notifications_template_context(x_sail_point_experimental) + print("The response of NotificationsApi->get_notifications_template_context:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NotificationsApi->get_notifications_template_context: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-from-addresses +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +List From Addresses +Retrieve a list of sender email addresses and their verification statuses + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-from-addresses) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + 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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | filters | **str** | (optional) | 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: **email**: *eq, ge, le, sw* + Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email** + +### Return type +[**List[EmailStatusDto]**](../models/email-status-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of Email Status | List[EmailStatusDto] | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.notifications_api import NotificationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.email_status_dto import EmailStatusDto +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + filters = 'email eq \"john.doe@company.com\"' # 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: **email**: *eq, ge, le, sw* (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: **email**: *eq, ge, le, sw* (optional) + sorters = 'email' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email** (optional) + + try: + # List From Addresses + + results = NotificationsApi(api_client).list_from_addresses(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).list_from_addresses(x_sail_point_experimental, limit, offset, count, filters, sorters) + print("The response of NotificationsApi->list_from_addresses:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NotificationsApi->list_from_addresses: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-notification-preferences +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +List Notification Preferences for tenant. +Returns a list of notification preferences for tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-notification-preferences) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**PreferencesDto**](../models/preferences-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Return preference for the given notification key. | PreferencesDto | - | +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 + +```python +from sailpoint.v2024.api.notifications_api import NotificationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.preferences_dto import PreferencesDto +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + + try: + # List Notification Preferences for tenant. + + results = NotificationsApi(api_client).list_notification_preferences(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).list_notification_preferences(x_sail_point_experimental) + print("The response of NotificationsApi->list_notification_preferences:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NotificationsApi->list_notification_preferences: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-notification-template-defaults +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +List Notification Template Defaults +This lists the default templates used for notifications, such as emails from IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-notification-template-defaults) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | filters | **str** | (optional) | 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* + +### Return type +[**List[TemplateDtoDefault]**](../models/template-dto-default) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of the default template objects | List[TemplateDtoDefault] | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.notifications_api import NotificationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.template_dto_default import TemplateDtoDefault +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + filters = 'key eq \"cloud_manual_work_item_summary\"' # 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + + try: + # List Notification Template Defaults + + results = NotificationsApi(api_client).list_notification_template_defaults(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).list_notification_template_defaults(x_sail_point_experimental, limit, offset, filters) + print("The response of NotificationsApi->list_notification_template_defaults:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NotificationsApi->list_notification_template_defaults: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-notification-templates +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +List Notification Templates +This lists the templates that you have modified for your site. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-notification-templates) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | filters | **str** | (optional) | 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* + +### Return type +[**List[TemplateDto]**](../models/template-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of template objects for your site | List[TemplateDto] | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.notifications_api import NotificationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.template_dto import TemplateDto +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + filters = 'medium eq \"EMAIL\"' # 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + + try: + # List Notification Templates + + results = NotificationsApi(api_client).list_notification_templates(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).list_notification_templates(x_sail_point_experimental, limit, offset, filters) + print("The response of NotificationsApi->list_notification_templates:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NotificationsApi->list_notification_templates: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-mail-from-attributes +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +Change MAIL FROM domain +Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller's DNS + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-mail-from-attributes) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Body | mail_from_attributes_dto | [**MailFromAttributesDto**](../models/mail-from-attributes-dto) | True | + +### Return type +[**MailFromAttributes**](../models/mail-from-attributes) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | MAIL FROM Attributes required to verify the change | MailFromAttributes | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.notifications_api import NotificationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.mail_from_attributes import MailFromAttributes +from sailpoint.v2024.models.mail_from_attributes_dto import MailFromAttributesDto +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + mail_from_attributes_dto = '''{ + "identity" : "BobSmith@sailpoint.com", + "mailFromDomain" : "example.sailpoint.com" + }''' # MailFromAttributesDto | + + try: + # Change MAIL FROM domain + new_mail_from_attributes_dto = MailFromAttributesDto.from_json(mail_from_attributes_dto) + results = NotificationsApi(api_client).put_mail_from_attributes(x_sail_point_experimental=x_sail_point_experimental, mail_from_attributes_dto=new_mail_from_attributes_dto) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).put_mail_from_attributes(x_sail_point_experimental, new_mail_from_attributes_dto) + print("The response of NotificationsApi->put_mail_from_attributes:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NotificationsApi->put_mail_from_attributes: %s\n" % e) +``` + + + +[[Back to top]](#) + +## send-test-notification +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +Send Test Notification +Send a Test Notification + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/send-test-notification) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Body | send_test_notification_request_dto | [**SendTestNotificationRequestDto**](../models/send-test-notification-request-dto) | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +204 | No content - indicates the request was successful but there is no content to be returned in the response. | | - | +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 + +```python +from sailpoint.v2024.api.notifications_api import NotificationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.send_test_notification_request_dto import SendTestNotificationRequestDto +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + send_test_notification_request_dto = '''{ + "context" : "{}", + "medium" : "EMAIL", + "key" : "cloud_manual_work_item_summary" + }''' # SendTestNotificationRequestDto | + + try: + # Send Test Notification + new_send_test_notification_request_dto = SendTestNotificationRequestDto.from_json(send_test_notification_request_dto) + NotificationsApi(api_client).send_test_notification(x_sail_point_experimental=x_sail_point_experimental, send_test_notification_request_dto=new_send_test_notification_request_dto) + # Below is a request that includes all optional parameters + # NotificationsApi(api_client).send_test_notification(x_sail_point_experimental, new_send_test_notification_request_dto) + except Exception as e: + print("Exception when calling NotificationsApi->send_test_notification: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/OAuthClientsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/OAuthClientsApi.md new file mode 100644 index 000000000..29ebd6f1a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/OAuthClientsApi.md @@ -0,0 +1,339 @@ +--- +id: v2024-o-auth-clients +title: OAuth_Clients +pagination_label: OAuth_Clients +sidebar_label: OAuth_Clients +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'OAuth_Clients', 'V2024OAuth_Clients'] +slug: /tools/sdk/python/v2024/methods/o-auth-clients +tags: ['SDK', 'Software Development Kit', 'OAuth_Clients', 'V2024OAuth_Clients'] +--- + +# sailpoint.v2024.OAuthClientsApi + Use this API to implement OAuth client functionality. +With this functionality in place, users with the appropriate security scopes can create and configure OAuth clients to use as a way to obtain authorization to use the Identity Security Cloud REST API. +Refer to [Authentication](https://developer.sailpoint.com/docs/api/authentication/) for more information about OAuth and how it works with the Identity Security Cloud REST API. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-oauth-client**](#create-oauth-client) | **POST** `/oauth-clients` | Create OAuth Client +[**delete-oauth-client**](#delete-oauth-client) | **DELETE** `/oauth-clients/{id}` | Delete OAuth Client +[**get-oauth-client**](#get-oauth-client) | **GET** `/oauth-clients/{id}` | Get OAuth Client +[**list-oauth-clients**](#list-oauth-clients) | **GET** `/oauth-clients` | List OAuth Clients +[**patch-oauth-client**](#patch-oauth-client) | **PATCH** `/oauth-clients/{id}` | Patch OAuth Client + + +## create-oauth-client +Create OAuth Client +This creates an OAuth client. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-oauth-client) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | create_o_auth_client_request | [**CreateOAuthClientRequest**](../models/create-o-auth-client-request) | True | + +### Return type +[**CreateOAuthClientResponse**](../models/create-o-auth-client-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Request succeeded. | CreateOAuthClientResponse | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.o_auth_clients_api import OAuthClientsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.create_o_auth_client_request import CreateOAuthClientRequest +from sailpoint.v2024.models.create_o_auth_client_response import CreateOAuthClientResponse +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + create_o_auth_client_request = '''{ + "internal" : false, + "businessName" : "Acme-Solar", + "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", + "refreshTokenValiditySeconds" : 86400, + "type" : "CONFIDENTIAL", + "redirectUris" : [ "http://localhost:12345" ], + "enabled" : true, + "accessType" : "OFFLINE", + "grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ], + "strongAuthSupported" : false, + "homepageUrl" : "http://localhost:12345", + "accessTokenValiditySeconds" : 750, + "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], + "name" : "Demo API Client", + "claimsSupported" : false + }''' # CreateOAuthClientRequest | + + try: + # Create OAuth Client + new_create_o_auth_client_request = CreateOAuthClientRequest.from_json(create_o_auth_client_request) + results = OAuthClientsApi(api_client).create_oauth_client(create_o_auth_client_request=new_create_o_auth_client_request) + # Below is a request that includes all optional parameters + # results = OAuthClientsApi(api_client).create_oauth_client(new_create_o_auth_client_request) + print("The response of OAuthClientsApi->create_oauth_client:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling OAuthClientsApi->create_oauth_client: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-oauth-client +Delete OAuth Client +This deletes an OAuth client. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-oauth-client) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The OAuth client id + +### 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. | 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 + +```python +from sailpoint.v2024.api.o_auth_clients_api import OAuthClientsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id + + try: + # Delete OAuth Client + + OAuthClientsApi(api_client).delete_oauth_client(id=id) + # Below is a request that includes all optional parameters + # OAuthClientsApi(api_client).delete_oauth_client(id) + except Exception as e: + print("Exception when calling OAuthClientsApi->delete_oauth_client: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-oauth-client +Get OAuth Client +This gets details of an OAuth client. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-oauth-client) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The OAuth client id + +### Return type +[**GetOAuthClientResponse**](../models/get-o-auth-client-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Request succeeded. | GetOAuthClientResponse | - | +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 + +```python +from sailpoint.v2024.api.o_auth_clients_api import OAuthClientsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.get_o_auth_client_response import GetOAuthClientResponse +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id + + try: + # Get OAuth Client + + results = OAuthClientsApi(api_client).get_oauth_client(id=id) + # Below is a request that includes all optional parameters + # results = OAuthClientsApi(api_client).get_oauth_client(id) + print("The response of OAuthClientsApi->get_oauth_client:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling OAuthClientsApi->get_oauth_client: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-oauth-clients +List OAuth Clients +This gets a list of OAuth clients. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-oauth-clients) + +### 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* + +### Return type +[**List[GetOAuthClientResponse]**](../models/get-o-auth-client-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of OAuth clients. | List[GetOAuthClientResponse] | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.o_auth_clients_api import OAuthClientsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.get_o_auth_client_response import GetOAuthClientResponse +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # 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: **lastUsed**: *le, isnull* (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: **lastUsed**: *le, isnull* (optional) + + try: + # List OAuth Clients + + results = OAuthClientsApi(api_client).list_oauth_clients() + # Below is a request that includes all optional parameters + # results = OAuthClientsApi(api_client).list_oauth_clients(filters) + print("The response of OAuthClientsApi->list_oauth_clients:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-oauth-client +Patch OAuth Client +This performs a targeted update to the field(s) of an OAuth client. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-oauth-client) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The OAuth client id + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported + +### Return type +[**GetOAuthClientResponse**](../models/get-o-auth-client-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Indicates the PATCH operation succeeded, and returns the OAuth client's new representation. | GetOAuthClientResponse | - | +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-patch+json + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2024.api.o_auth_clients_api import OAuthClientsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.get_o_auth_client_response import GetOAuthClientResponse +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id + json_patch_operation = '''[{op=replace, path=/strongAuthSupported, value=true}, {op=replace, path=/businessName, value=acme-solar}]''' # List[JsonPatchOperation] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported + + try: + # Patch OAuth Client + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = OAuthClientsApi(api_client).patch_oauth_client(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = OAuthClientsApi(api_client).patch_oauth_client(id, new_json_patch_operation) + print("The response of OAuthClientsApi->patch_oauth_client:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling OAuthClientsApi->patch_oauth_client: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/OrgConfigApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/OrgConfigApi.md new file mode 100644 index 000000000..db647bdc7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/OrgConfigApi.md @@ -0,0 +1,246 @@ +--- +id: v2024-org-config +title: Org_Config +pagination_label: Org_Config +sidebar_label: Org_Config +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Org_Config', 'V2024Org_Config'] +slug: /tools/sdk/python/v2024/methods/org-config +tags: ['SDK', 'Software Development Kit', 'Org_Config', 'V2024Org_Config'] +--- + +# sailpoint.v2024.OrgConfigApi + Use this API to implement organization configuration functionality. +Administrators can use this functionality to manage organization settings, such as time zones. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-org-config**](#get-org-config) | **GET** `/org-config` | Get Org Config Settings +[**get-valid-time-zones**](#get-valid-time-zones) | **GET** `/org-config/valid-time-zones` | Get Valid Time Zones +[**patch-org-config**](#patch-org-config) | **PATCH** `/org-config` | Patch Org Config + + +## get-org-config +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +Get Org Config Settings +Get the current organization's configuration settings, only external accessible properties. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-org-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**OrgConfig**](../models/org-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Request succeeded. | OrgConfig | - | +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 + +```python +from sailpoint.v2024.api.org_config_api import OrgConfigApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.org_config import OrgConfig +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + + try: + # Get Org Config Settings + + results = OrgConfigApi(api_client).get_org_config(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = OrgConfigApi(api_client).get_org_config(x_sail_point_experimental) + print("The response of OrgConfigApi->get_org_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling OrgConfigApi->get_org_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-valid-time-zones +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +Get Valid Time Zones +List the valid time zones that can be set in organization configurations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-valid-time-zones) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Query | limit | **int** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +**List[str]** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Request successful. | 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. | ListAccessProfiles401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | 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 + +```python +from sailpoint.v2024.api.org_config_api import OrgConfigApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + 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: + # Get Valid Time Zones + + results = OrgConfigApi(api_client).get_valid_time_zones(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = OrgConfigApi(api_client).get_valid_time_zones(x_sail_point_experimental, limit, offset, count) + print("The response of OrgConfigApi->get_valid_time_zones:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling OrgConfigApi->get_valid_time_zones: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-org-config +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +Patch Org Config +Patch the current organization's configuration, using http://jsonpatch.com/ syntax. This is commonly used to changing an organization's time zone. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-org-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +### Return type +[**OrgConfig**](../models/org-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Successfully patched org config. | OrgConfig | - | +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-patch+json + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2024.api.org_config_api import OrgConfigApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation +from sailpoint.v2024.models.org_config import OrgConfig +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch_operation = '''[{op=replace, path=/timeZone, value=America/Toronto}]''' # List[JsonPatchOperation] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + try: + # Patch Org Config + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = OrgConfigApi(api_client).patch_org_config(x_sail_point_experimental=x_sail_point_experimental, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = OrgConfigApi(api_client).patch_org_config(x_sail_point_experimental, new_json_patch_operation) + print("The response of OrgConfigApi->patch_org_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling OrgConfigApi->patch_org_config: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/PasswordConfigurationApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordConfigurationApi.md new file mode 100644 index 000000000..be27cfa4f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordConfigurationApi.md @@ -0,0 +1,214 @@ +--- +id: v2024-password-configuration +title: Password_Configuration +pagination_label: Password_Configuration +sidebar_label: Password_Configuration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Password_Configuration', 'V2024Password_Configuration'] +slug: /tools/sdk/python/v2024/methods/password-configuration +tags: ['SDK', 'Software Development Kit', 'Password_Configuration', 'V2024Password_Configuration'] +--- + +# sailpoint.v2024.PasswordConfigurationApi + Use this API to implement organization password configuration functionality. +With this functionality in place, organization administrators can create organization-specific password configurations. + +These configurations include details like custom password instructions, as well as digit token length and duration. + +Refer to [Configuring User Authentication for Password Resets](https://documentation.sailpoint.com/saas/help/pwd/pwd_reset.html) for more information about organization password configuration functionality. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-password-org-config**](#create-password-org-config) | **POST** `/password-org-config` | Create Password Org Config +[**get-password-org-config**](#get-password-org-config) | **GET** `/password-org-config` | Get Password Org Config +[**put-password-org-config**](#put-password-org-config) | **PUT** `/password-org-config` | Update Password Org Config + + +## create-password-org-config +Create Password Org Config +This API creates the password org config. Unspecified fields will use default value. +To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to "true". +Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-password-org-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | password_org_config | [**PasswordOrgConfig**](../models/password-org-config) | True | + +### Return type +[**PasswordOrgConfig**](../models/password-org-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Reference to the password org config. | PasswordOrgConfig | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.password_configuration_api import PasswordConfigurationApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.password_org_config import PasswordOrgConfig +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + password_org_config = '''{ + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + }''' # PasswordOrgConfig | + + try: + # Create Password Org Config + new_password_org_config = PasswordOrgConfig.from_json(password_org_config) + results = PasswordConfigurationApi(api_client).create_password_org_config(password_org_config=new_password_org_config) + # Below is a request that includes all optional parameters + # results = PasswordConfigurationApi(api_client).create_password_org_config(new_password_org_config) + print("The response of PasswordConfigurationApi->create_password_org_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordConfigurationApi->create_password_org_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-password-org-config +Get Password Org Config +This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-password-org-config) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**PasswordOrgConfig**](../models/password-org-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Reference to the password org config. | PasswordOrgConfig | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.password_configuration_api import PasswordConfigurationApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.password_org_config import PasswordOrgConfig +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + + try: + # Get Password Org Config + + results = PasswordConfigurationApi(api_client).get_password_org_config() + # Below is a request that includes all optional parameters + # results = PasswordConfigurationApi(api_client).get_password_org_config() + print("The response of PasswordConfigurationApi->get_password_org_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordConfigurationApi->get_password_org_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-password-org-config +Update Password Org Config +This API updates the password org config for specified fields. Other fields will keep original value. +You must set the `customInstructionsEnabled` field to "true" to be able to use custom password instructions. +Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-password-org-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | password_org_config | [**PasswordOrgConfig**](../models/password-org-config) | True | + +### Return type +[**PasswordOrgConfig**](../models/password-org-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Reference to the password org config. | PasswordOrgConfig | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.password_configuration_api import PasswordConfigurationApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.password_org_config import PasswordOrgConfig +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + password_org_config = '''{ + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + }''' # PasswordOrgConfig | + + try: + # Update Password Org Config + new_password_org_config = PasswordOrgConfig.from_json(password_org_config) + results = PasswordConfigurationApi(api_client).put_password_org_config(password_org_config=new_password_org_config) + # Below is a request that includes all optional parameters + # results = PasswordConfigurationApi(api_client).put_password_org_config(new_password_org_config) + print("The response of PasswordConfigurationApi->put_password_org_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordConfigurationApi->put_password_org_config: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/PasswordDictionaryApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordDictionaryApi.md new file mode 100644 index 000000000..800107bda --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordDictionaryApi.md @@ -0,0 +1,237 @@ +--- +id: v2024-password-dictionary +title: Password_Dictionary +pagination_label: Password_Dictionary +sidebar_label: Password_Dictionary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Password_Dictionary', 'V2024Password_Dictionary'] +slug: /tools/sdk/python/v2024/methods/password-dictionary +tags: ['SDK', 'Software Development Kit', 'Password_Dictionary', 'V2024Password_Dictionary'] +--- + +# sailpoint.v2024.PasswordDictionaryApi + Use this API to implement password dictionary functionality. +With this functionality in place, administrators can create password dictionaries to prevent users from using certain words or characters in their passwords. + +A password dictionary is a list of words or characters that users are prevented from including in their passwords. +This can help protect users from themselves and force them to create passwords that are not easy to break. + +A password dictionary must meet the following requirements to for the API to handle them correctly: + +- It must be in .txt format. + +- All characters must be UTF-8 characters. + +- Each line must contain a single word or character with no spaces or whitespace characters. + +- It must contain at least one line other than the locale string. + +- Each line must not exceed 128 characters. + +- The file must not exceed 2500 lines. + +Administrators should also consider the following when they create their dictionaries: + +- Lines starting with a # represent comments. + +- All words in the password dictionary are case-insensitive. +For example, adding the word "password" to the dictionary also disallows the following: PASSWORD, Password, and PassWord. + +- The dictionary uses substring matching. +For example, adding the word "spring" to the dictionary also disallows the following: Spring124, 345SprinG, and 8spring. +Users can then select 'Change Password' to update their passwords. + +Administrators must do the following to create a password dictionary: + +- Create the text file that will contain the prohibited password values. + +- If the dictionary is not in English, they must add a locale string to the top line: locale:`languageCode`_`countryCode` + +The languageCode value refers to the language's 2-letter ISO 639-1 code. +The countryCode value refers to the country's 2-letter ISO 3166-1 code. + +Refer to this list https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html to see all the available ISO 639-1 language codes and ISO 3166-1 country codes. + +- Upload the .txt file to Identity Security Cloud with [Update Password Dictionary](https://developer.sailpoint.com/docs/api/v2024/put-password-dictionary). Uploading a new file always overwrites the previous dictionary file. + +Administrators can then specify which password policies check new passwords against the password dictionary by doing the following: In the Admin panel, they can use the Password Mgmt dropdown menu to select Policies, select the policy, and select the 'Prevent use of words in this site's password dictionary' checkbox beside it. + +Refer to [Configuring Advanced Password Management Options](https://documentation.sailpoint.com/saas/help/pwd/adv_config.html) for more information about password dictionaries. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-password-dictionary**](#get-password-dictionary) | **GET** `/password-dictionary` | Get Password Dictionary +[**put-password-dictionary**](#put-password-dictionary) | **PUT** `/password-dictionary` | Update Password Dictionary + + +## get-password-dictionary +Get Password Dictionary +This gets password dictionary for the organization. +The password dictionary file can contain lines that are: +1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing +2. empty lines +3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines +4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; + maximum length of the line is 128 Unicode codepoints + + +Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). + Password dict file must contain UTF-8 characters only. + +# Sample password text file + +``` + +# Password dictionary small test file + +locale=en_US + +# Password dictionary prohibited words + +qwerty +abcd +aaaaa +password +qazxsws + +``` + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-password-dictionary) + +### Parameters +This endpoint does not need any parameter. + +### Return type +**str** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A password dictionary response | 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. | 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**: text/plain, application/json + +### Example + +```python +from sailpoint.v2024.api.password_dictionary_api import PasswordDictionaryApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + + try: + # Get Password Dictionary + + results = PasswordDictionaryApi(api_client).get_password_dictionary() + # Below is a request that includes all optional parameters + # results = PasswordDictionaryApi(api_client).get_password_dictionary() + print("The response of PasswordDictionaryApi->get_password_dictionary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordDictionaryApi->get_password_dictionary: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-password-dictionary +Update Password Dictionary +This updates password dictionary for the organization. +The password dictionary file can contain lines that are: +1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing +2. empty lines +3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines +4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; + maximum length of the line is 128 Unicode codepoints + + +Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). + Password dict file must contain UTF-8 characters only. + +# Sample password text file + +``` + +# Password dictionary small test file + +locale=en_US + +# Password dictionary prohibited words + +qwerty +abcd +aaaaa +password +qazxsws + +``` + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-password-dictionary) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | file | **bytearray** | (optional) | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Successfully updated. | | - | +201 | Created. | | - | +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**: multipart/form-data + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2024.api.password_dictionary_api import PasswordDictionaryApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + file = None # bytearray | (optional) # bytearray | (optional) + + try: + # Update Password Dictionary + + PasswordDictionaryApi(api_client).put_password_dictionary() + # Below is a request that includes all optional parameters + # PasswordDictionaryApi(api_client).put_password_dictionary(file) + except Exception as e: + print("Exception when calling PasswordDictionaryApi->put_password_dictionary: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/PasswordManagementApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordManagementApi.md new file mode 100644 index 000000000..bd02d467d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordManagementApi.md @@ -0,0 +1,332 @@ +--- +id: v2024-password-management +title: Password_Management +pagination_label: Password_Management +sidebar_label: Password_Management +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Password_Management', 'V2024Password_Management'] +slug: /tools/sdk/python/v2024/methods/password-management +tags: ['SDK', 'Software Development Kit', 'Password_Management', 'V2024Password_Management'] +--- + +# sailpoint.v2024.PasswordManagementApi + Use this API to implement password management functionality. +With this functionality in place, users can manage their identity passwords for all their applications. + +In Identity Security Cloud, users can select their names in the upper right corner of the page and use the drop-down menu to select Password Manager. +Password Manager lists the user's identity's applications, possibly grouped to share passwords. +Users can then select 'Change Password' to update their passwords. + +Grouping passwords allows users to update their passwords more broadly, rather than requiring them to update each password individually. +Password Manager may list the applications and sources in the following groups: + +- Password Group: This refers to a group of applications that share a password. +For example, a user can use the same password for Google Drive, Google Mail, and YouTube. +Updating the password for the password group updates the password for all its included applications. + +- Multi-Application Source: This refers to a source with multiple applications that share a password. +For example, a user can have a source, G Suite, that includes the Google Calendar, Google Drive, and Google Mail applications. +Updating the password for the multi-application source updates the password for all its included applications. + +- Applications: These are applications that do not share passwords with other applications. + +An organization may require some authentication for users to update their passwords. +Users may be required to answer security questions or use a third-party authenticator before they can confirm their updates. + +Refer to [Managing Passwords](https://documentation.sailpoint.com/saas/user-help/accounts/passwords.html) for more information about password management. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-digit-token**](#create-digit-token) | **POST** `/generate-password-reset-token/digit` | Generate a digit token +[**get-password-change-status**](#get-password-change-status) | **GET** `/password-change-status/{id}` | Get Password Change Request Status +[**query-password-info**](#query-password-info) | **POST** `/query-password-info` | Query Password Info +[**set-password**](#set-password) | **POST** `/set-password` | Set Identity's Password + + +## create-digit-token +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +Generate a digit token +This API is used to generate a digit token for password management. Requires authorization scope of "idn:password-digit-token:create". + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-digit-token) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Body | password_digit_token_reset | [**PasswordDigitTokenReset**](../models/password-digit-token-reset) | True | + +### Return type +[**PasswordDigitToken**](../models/password-digit-token) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The digit token for password management. | PasswordDigitToken | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.password_management_api import PasswordManagementApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.password_digit_token import PasswordDigitToken +from sailpoint.v2024.models.password_digit_token_reset import PasswordDigitTokenReset +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + password_digit_token_reset = '''{ + "durationMinutes" : 5, + "length" : 8, + "userId" : "Abby.Smith" + }''' # PasswordDigitTokenReset | + + try: + # Generate a digit token + new_password_digit_token_reset = PasswordDigitTokenReset.from_json(password_digit_token_reset) + results = PasswordManagementApi(api_client).create_digit_token(x_sail_point_experimental=x_sail_point_experimental, password_digit_token_reset=new_password_digit_token_reset) + # Below is a request that includes all optional parameters + # results = PasswordManagementApi(api_client).create_digit_token(x_sail_point_experimental, new_password_digit_token_reset) + print("The response of PasswordManagementApi->create_digit_token:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordManagementApi->create_digit_token: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-password-change-status +Get Password Change Request Status +This API returns the status of a password change request. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-password-change-status) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Password change request ID + +### Return type +[**PasswordStatus**](../models/password-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Status of the password change request | PasswordStatus | - | +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 + +```python +from sailpoint.v2024.api.password_management_api import PasswordManagementApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.password_status import PasswordStatus +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = '089899f13a8f4da7824996191587bab9' # str | Password change request ID # str | Password change request ID + + try: + # Get Password Change Request Status + + results = PasswordManagementApi(api_client).get_password_change_status(id=id) + # Below is a request that includes all optional parameters + # results = PasswordManagementApi(api_client).get_password_change_status(id) + print("The response of PasswordManagementApi->get_password_change_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordManagementApi->get_password_change_status: %s\n" % e) +``` + + + +[[Back to top]](#) + +## query-password-info +Query Password Info +This API is used to query password related information. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/query-password-info) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | password_info_query_dto | [**PasswordInfoQueryDTO**](../models/password-info-query-dto) | True | + +### Return type +[**PasswordInfo**](../models/password-info) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Reference to the password info. | PasswordInfo | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.password_management_api import PasswordManagementApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.password_info import PasswordInfo +from sailpoint.v2024.models.password_info_query_dto import PasswordInfoQueryDTO +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + password_info_query_dto = '''{ + "sourceName" : "My-AD", + "userName" : "Abby.Smith" + }''' # PasswordInfoQueryDTO | + + try: + # Query Password Info + new_password_info_query_dto = PasswordInfoQueryDto.from_json(password_info_query_dto) + results = PasswordManagementApi(api_client).query_password_info(password_info_query_dto=new_password_info_query_dto) + # Below is a request that includes all optional parameters + # results = PasswordManagementApi(api_client).query_password_info(new_password_info_query_dto) + print("The response of PasswordManagementApi->query_password_info:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordManagementApi->query_password_info: %s\n" % e) +``` + + + +[[Back to top]](#) + +## set-password +Set Identity's Password +This API is used to set a password for an identity. + +An identity can change their own password (as well as any of their accounts' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or ["authorization_code" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). + +>**Note: If you want to set an identity's source account password, you must enable `PASSWORD` as one of the source's features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** + +To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: + +```bash +echo -n "myPassword" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 +``` + +In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. + +To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. + +If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. + +You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-password) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | password_change_request | [**PasswordChangeRequest**](../models/password-change-request) | True | + +### Return type +[**PasswordChangeResponse**](../models/password-change-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Reference to the password change. | PasswordChangeResponse | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.password_management_api import PasswordManagementApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.password_change_request import PasswordChangeRequest +from sailpoint.v2024.models.password_change_response import PasswordChangeResponse +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + password_change_request = '''{ + "sourceId" : "8a807d4c73c545510173c545d4b60246", + "accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", + "identityId" : "8a807d4c73c545510173c545f0a002ff", + "publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", + "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" + }''' # PasswordChangeRequest | + + try: + # Set Identity's Password + new_password_change_request = PasswordChangeRequest.from_json(password_change_request) + results = PasswordManagementApi(api_client).set_password(password_change_request=new_password_change_request) + # Below is a request that includes all optional parameters + # results = PasswordManagementApi(api_client).set_password(new_password_change_request) + print("The response of PasswordManagementApi->set_password:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordManagementApi->set_password: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/PasswordPoliciesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordPoliciesApi.md new file mode 100644 index 000000000..0caba087d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordPoliciesApi.md @@ -0,0 +1,396 @@ +--- +id: v2024-password-policies +title: Password_Policies +pagination_label: Password_Policies +sidebar_label: Password_Policies +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Password_Policies', 'V2024Password_Policies'] +slug: /tools/sdk/python/v2024/methods/password-policies +tags: ['SDK', 'Software Development Kit', 'Password_Policies', 'V2024Password_Policies'] +--- + +# sailpoint.v2024.PasswordPoliciesApi + Use these APIs to implement password policies functionality. +These APIs allow you to define the policy parameters for choosing passwords. + +IdentityNow comes with a default policy that you can modify to define the password requirements your users must meet to log in to IdentityNow, such as requiring a minimum password length, including special characters, and disallowing certain patterns. +If you have licensed Password Management, you can create additional password policies beyond the default one to manage passwords for supported sources in your org. + +In the Identity Security Cloud Admin panel, administrators can use the Password Mgmt dropdown menu to select Sync Groups. +Refer to [Managing Password Policies](https://documentation.sailpoint.com/saas/help/pwd/pwd_policies/pwd_policies.html) for more information about password policies. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-password-policy**](#create-password-policy) | **POST** `/password-policies` | Create Password Policy +[**delete-password-policy**](#delete-password-policy) | **DELETE** `/password-policies/{id}` | Delete Password Policy by ID +[**get-password-policy-by-id**](#get-password-policy-by-id) | **GET** `/password-policies/{id}` | Get Password Policy by ID +[**list-password-policies**](#list-password-policies) | **GET** `/password-policies` | List Password Policies +[**set-password-policy**](#set-password-policy) | **PUT** `/password-policies/{id}` | Update Password Policy by ID + + +## create-password-policy +Create Password Policy +This API creates the specified password policy. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-password-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | password_policy_v3_dto | [**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) | True | + +### Return type +[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Reference to the password policy. | PasswordPolicyV3Dto | - | +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 + +```python +from sailpoint.v2024.api.password_policies_api import PasswordPoliciesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.password_policy_v3_dto import PasswordPolicyV3Dto +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + password_policy_v3_dto = '''{ + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : 1939056206564, + "validateAgainstAccountId" : false, + "dateCreated" : 1639056206564, + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + }''' # PasswordPolicyV3Dto | + + try: + # Create Password Policy + new_password_policy_v3_dto = PasswordPolicyV3Dto.from_json(password_policy_v3_dto) + results = PasswordPoliciesApi(api_client).create_password_policy(password_policy_v3_dto=new_password_policy_v3_dto) + # Below is a request that includes all optional parameters + # results = PasswordPoliciesApi(api_client).create_password_policy(new_password_policy_v3_dto) + print("The response of PasswordPoliciesApi->create_password_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->create_password_policy: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-password-policy +Delete Password Policy by ID +This API deletes the specified password policy. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-password-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of password policy to delete. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +204 | No content - indicates the request was successful but there is no content to be returned in the response. | | - | +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 + +```python +from sailpoint.v2024.api.password_policies_api import PasswordPoliciesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ff808081838d9e9d01838da6a03e0002' # str | The ID of password policy to delete. # str | The ID of password policy to delete. + + try: + # Delete Password Policy by ID + + PasswordPoliciesApi(api_client).delete_password_policy(id=id) + # Below is a request that includes all optional parameters + # PasswordPoliciesApi(api_client).delete_password_policy(id) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->delete_password_policy: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-password-policy-by-id +Get Password Policy by ID +This API returns the password policy for the specified ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-password-policy-by-id) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of password policy to retrieve. + +### Return type +[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Reference to the password policy. | PasswordPolicyV3Dto | - | +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 + +```python +from sailpoint.v2024.api.password_policies_api import PasswordPoliciesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.password_policy_v3_dto import PasswordPolicyV3Dto +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ff808081838d9e9d01838da6a03e0005' # str | The ID of password policy to retrieve. # str | The ID of password policy to retrieve. + + try: + # Get Password Policy by ID + + results = PasswordPoliciesApi(api_client).get_password_policy_by_id(id=id) + # Below is a request that includes all optional parameters + # results = PasswordPoliciesApi(api_client).get_password_policy_by_id(id) + print("The response of PasswordPoliciesApi->get_password_policy_by_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->get_password_policy_by_id: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-password-policies +List Password Policies +This gets list of all Password Policies. +Requires role of ORG_ADMIN + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-password-policies) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + 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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**List[PasswordPolicyV3Dto]**](../models/password-policy-v3-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of all Password Policies. | List[PasswordPolicyV3Dto] | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.password_policies_api import PasswordPoliciesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.password_policy_v3_dto import PasswordPolicyV3Dto +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + 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 Password Policies + + results = PasswordPoliciesApi(api_client).list_password_policies() + # Below is a request that includes all optional parameters + # results = PasswordPoliciesApi(api_client).list_password_policies(limit, offset, count) + print("The response of PasswordPoliciesApi->list_password_policies:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->list_password_policies: %s\n" % e) +``` + + + +[[Back to top]](#) + +## set-password-policy +Update Password Policy by ID +This API updates the specified password policy. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-password-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of password policy to update. + Body | password_policy_v3_dto | [**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) | True | + +### Return type +[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Reference to the password policy. | PasswordPolicyV3Dto | - | +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 + +```python +from sailpoint.v2024.api.password_policies_api import PasswordPoliciesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.password_policy_v3_dto import PasswordPolicyV3Dto +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ff808081838d9e9d01838da6a03e0007' # str | The ID of password policy to update. # str | The ID of password policy to update. + password_policy_v3_dto = '''{ + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : 1939056206564, + "validateAgainstAccountId" : false, + "dateCreated" : 1639056206564, + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + }''' # PasswordPolicyV3Dto | + + try: + # Update Password Policy by ID + new_password_policy_v3_dto = PasswordPolicyV3Dto.from_json(password_policy_v3_dto) + results = PasswordPoliciesApi(api_client).set_password_policy(id=id, password_policy_v3_dto=new_password_policy_v3_dto) + # Below is a request that includes all optional parameters + # results = PasswordPoliciesApi(api_client).set_password_policy(id, new_password_policy_v3_dto) + print("The response of PasswordPoliciesApi->set_password_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->set_password_policy: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/PasswordSyncGroupsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordSyncGroupsApi.md new file mode 100644 index 000000000..72223bfcd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordSyncGroupsApi.md @@ -0,0 +1,367 @@ +--- +id: v2024-password-sync-groups +title: Password_Sync_Groups +pagination_label: Password_Sync_Groups +sidebar_label: Password_Sync_Groups +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Password_Sync_Groups', 'V2024Password_Sync_Groups'] +slug: /tools/sdk/python/v2024/methods/password-sync-groups +tags: ['SDK', 'Software Development Kit', 'Password_Sync_Groups', 'V2024Password_Sync_Groups'] +--- + +# sailpoint.v2024.PasswordSyncGroupsApi + Use this API to implement password sync group functionality. +With this functionality in place, administrators can group sources into password sync groups so that all their applications share the same password. +This allows users to update the password for all the applications in a sync group if they want, rather than updating each password individually. + +A password sync group is a group of applications that shares a password. +Administrators create these groups by grouping the applications' sources. +For example, an administrator can group the ActiveDirectory, GitHub, and G Suite sources together so that all those sources' applications can also be grouped to share a password. +A user can then update his or her password for ActiveDirectory, GitHub, Gmail, Google Drive, and Google Calendar all at once, rather then updating each one individually. + +The following are required for administrators to create a password sync group in Identity Security Cloud: + +- At least two direct connect sources connected to Identity Security Cloud and configured for Password Management. + +- Each authentication source in a sync group must have at least one application. Refer to [Adding and Resetting Application Passwords](https://documentation.sailpoint.com/saas/help/pwd/adv_config.html#adding-and-resetting-application-passwords) for more information about adding applications to sources. + +- At least one password policy. Refer to [Managing Password Policies](https://documentation.sailpoint.com/saas/help/pwd/policies.html) for more information about password policies. + +In the Admin panel in Identity Security Cloud, administrators can use the Password Mgmt dropdown menu to select Sync Groups. +To create a sync group, administrators must provide a name, choose a password policy to be enforced across the sources in the sync group, and select the sources to include in the sync group. + +Administrators can also delete sync groups in Identity Security Cloud, but they should know the following before they do: + +- Passwords related to the associated sources will become independent, so changing one will not change the others anymore. + +- Passwords for the sources' connected applications will also become independent. + +- Password policies assigned to the sync group are then assigned directly to the associated sources. +To change the password policy for a source, administrators must edit it directly. + +Once the password sync group has been created, users can update the password for the group in Password Manager. + +Refer to [Managing Password Sync Groups](https://documentation.sailpoint.com/saas/help/pwd/sync_grps.html) for more information about password sync groups. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-password-sync-group**](#create-password-sync-group) | **POST** `/password-sync-groups` | Create Password Sync Group +[**delete-password-sync-group**](#delete-password-sync-group) | **DELETE** `/password-sync-groups/{id}` | Delete Password Sync Group by ID +[**get-password-sync-group**](#get-password-sync-group) | **GET** `/password-sync-groups/{id}` | Get Password Sync Group by ID +[**get-password-sync-groups**](#get-password-sync-groups) | **GET** `/password-sync-groups` | Get Password Sync Group List +[**update-password-sync-group**](#update-password-sync-group) | **PUT** `/password-sync-groups/{id}` | Update Password Sync Group by ID + + +## create-password-sync-group +Create Password Sync Group +This API creates a password sync group based on the specifications provided. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-password-sync-group) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | password_sync_group | [**PasswordSyncGroup**](../models/password-sync-group) | True | + +### Return type +[**PasswordSyncGroup**](../models/password-sync-group) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Reference to the password sync group. | PasswordSyncGroup | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.password_sync_groups_api import PasswordSyncGroupsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.password_sync_group import PasswordSyncGroup +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + password_sync_group = '''{ + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }''' # PasswordSyncGroup | + + try: + # Create Password Sync Group + new_password_sync_group = PasswordSyncGroup.from_json(password_sync_group) + results = PasswordSyncGroupsApi(api_client).create_password_sync_group(password_sync_group=new_password_sync_group) + # Below is a request that includes all optional parameters + # results = PasswordSyncGroupsApi(api_client).create_password_sync_group(new_password_sync_group) + print("The response of PasswordSyncGroupsApi->create_password_sync_group:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->create_password_sync_group: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-password-sync-group +Delete Password Sync Group by ID +This API deletes the specified password sync group. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-password-sync-group) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of password sync group to delete. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +204 | No content - indicates the request was successful but there is no content to be returned in the response. | | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.password_sync_groups_api import PasswordSyncGroupsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = '6881f631-3bd5-4213-9c75-8e05cc3e35dd' # str | The ID of password sync group to delete. # str | The ID of password sync group to delete. + + try: + # Delete Password Sync Group by ID + + PasswordSyncGroupsApi(api_client).delete_password_sync_group(id=id) + # Below is a request that includes all optional parameters + # PasswordSyncGroupsApi(api_client).delete_password_sync_group(id) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->delete_password_sync_group: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-password-sync-group +Get Password Sync Group by ID +This API returns the sync group for the specified ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-password-sync-group) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of password sync group to retrieve. + +### Return type +[**PasswordSyncGroup**](../models/password-sync-group) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Reference to the password sync group. | PasswordSyncGroup | - | +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 + +```python +from sailpoint.v2024.api.password_sync_groups_api import PasswordSyncGroupsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.password_sync_group import PasswordSyncGroup +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = '6881f631-3bd5-4213-9c75-8e05cc3e35dd' # str | The ID of password sync group to retrieve. # str | The ID of password sync group to retrieve. + + try: + # Get Password Sync Group by ID + + results = PasswordSyncGroupsApi(api_client).get_password_sync_group(id=id) + # Below is a request that includes all optional parameters + # results = PasswordSyncGroupsApi(api_client).get_password_sync_group(id) + print("The response of PasswordSyncGroupsApi->get_password_sync_group:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->get_password_sync_group: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-password-sync-groups +Get Password Sync Group List +This API returns a list of password sync groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-password-sync-groups) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + 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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**List[PasswordSyncGroup]**](../models/password-sync-group) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of password sync groups. | List[PasswordSyncGroup] | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.password_sync_groups_api import PasswordSyncGroupsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.password_sync_group import PasswordSyncGroup +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + 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: + # Get Password Sync Group List + + results = PasswordSyncGroupsApi(api_client).get_password_sync_groups() + # Below is a request that includes all optional parameters + # results = PasswordSyncGroupsApi(api_client).get_password_sync_groups(limit, offset, count) + print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->get_password_sync_groups: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-password-sync-group +Update Password Sync Group by ID +This API updates the specified password sync group. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-password-sync-group) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of password sync group to update. + Body | password_sync_group | [**PasswordSyncGroup**](../models/password-sync-group) | True | + +### Return type +[**PasswordSyncGroup**](../models/password-sync-group) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Reference to the password sync group. | PasswordSyncGroup | - | +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 + +```python +from sailpoint.v2024.api.password_sync_groups_api import PasswordSyncGroupsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.password_sync_group import PasswordSyncGroup +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = '6881f631-3bd5-4213-9c75-8e05cc3e35dd' # str | The ID of password sync group to update. # str | The ID of password sync group to update. + password_sync_group = '''{ + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }''' # PasswordSyncGroup | + + try: + # Update Password Sync Group by ID + new_password_sync_group = PasswordSyncGroup.from_json(password_sync_group) + results = PasswordSyncGroupsApi(api_client).update_password_sync_group(id=id, password_sync_group=new_password_sync_group) + # Below is a request that includes all optional parameters + # results = PasswordSyncGroupsApi(api_client).update_password_sync_group(id, new_password_sync_group) + print("The response of PasswordSyncGroupsApi->update_password_sync_group:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->update_password_sync_group: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/PersonalAccessTokensApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/PersonalAccessTokensApi.md new file mode 100644 index 000000000..9dac7471f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/PersonalAccessTokensApi.md @@ -0,0 +1,278 @@ +--- +id: v2024-personal-access-tokens +title: Personal_Access_Tokens +pagination_label: Personal_Access_Tokens +sidebar_label: Personal_Access_Tokens +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Personal_Access_Tokens', 'V2024Personal_Access_Tokens'] +slug: /tools/sdk/python/v2024/methods/personal-access-tokens +tags: ['SDK', 'Software Development Kit', 'Personal_Access_Tokens', 'V2024Personal_Access_Tokens'] +--- + +# sailpoint.v2024.PersonalAccessTokensApi + Use this API to implement personal access token (PAT) functionality. +With this functionality in place, users can use PATs as an alternative to passwords for authentication in Identity Security Cloud. + +PATs embed user information into the client ID and secret. +This replaces the API clients' need to store and provide a username and password to establish a connection, improving Identity Security Cloud organizations' integration security. + +In Identity Security Cloud, users can do the following to create and manage their PATs: Select the dropdown menu under their names, select Preferences, and then select Personal Access Tokens. +They must then provide a description about the token's purpose. +They can then select 'Create Token' at the bottom of the page to generate and view the Secret and Client ID. + +Refer to [Managing Personal Access Tokens](https://documentation.sailpoint.com/saas/help/common/generate_tokens.html) for more information about PATs. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-personal-access-token**](#create-personal-access-token) | **POST** `/personal-access-tokens` | Create Personal Access Token +[**delete-personal-access-token**](#delete-personal-access-token) | **DELETE** `/personal-access-tokens/{id}` | Delete Personal Access Token +[**list-personal-access-tokens**](#list-personal-access-tokens) | **GET** `/personal-access-tokens` | List Personal Access Tokens +[**patch-personal-access-token**](#patch-personal-access-token) | **PATCH** `/personal-access-tokens/{id}` | Patch Personal Access Token + + +## create-personal-access-token +Create Personal Access Token +This creates a personal access token. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-personal-access-token) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | create_personal_access_token_request | [**CreatePersonalAccessTokenRequest**](../models/create-personal-access-token-request) | True | Name and scope of personal access token. + +### Return type +[**CreatePersonalAccessTokenResponse**](../models/create-personal-access-token-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Created. Note - this is the only time Personal Access Tokens' secret attribute will be displayed. | CreatePersonalAccessTokenResponse | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.personal_access_tokens_api import PersonalAccessTokensApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.create_personal_access_token_request import CreatePersonalAccessTokenRequest +from sailpoint.v2024.models.create_personal_access_token_response import CreatePersonalAccessTokenResponse +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + create_personal_access_token_request = '''{ + "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], + "accessTokenValiditySeconds" : 36900, + "name" : "NodeJS Integration" + }''' # CreatePersonalAccessTokenRequest | Name and scope of personal access token. + + try: + # Create Personal Access Token + new_create_personal_access_token_request = CreatePersonalAccessTokenRequest.from_json(create_personal_access_token_request) + results = PersonalAccessTokensApi(api_client).create_personal_access_token(create_personal_access_token_request=new_create_personal_access_token_request) + # Below is a request that includes all optional parameters + # results = PersonalAccessTokensApi(api_client).create_personal_access_token(new_create_personal_access_token_request) + print("The response of PersonalAccessTokensApi->create_personal_access_token:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->create_personal_access_token: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-personal-access-token +Delete Personal Access Token +This deletes a personal access token. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-personal-access-token) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The personal access token id + +### 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. | 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 + +```python +from sailpoint.v2024.api.personal_access_tokens_api import PersonalAccessTokensApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The personal access token id # str | The personal access token id + + try: + # Delete Personal Access Token + + PersonalAccessTokensApi(api_client).delete_personal_access_token(id=id) + # Below is a request that includes all optional parameters + # PersonalAccessTokensApi(api_client).delete_personal_access_token(id) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->delete_personal_access_token: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-personal-access-tokens +List Personal Access Tokens +This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-personal-access-tokens) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | owner_id | **str** | (optional) | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' + Query | filters | **str** | (optional) | 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: **lastUsed**: *le, isnull* + +### Return type +[**List[GetPersonalAccessTokenResponse]**](../models/get-personal-access-token-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of personal access tokens. | List[GetPersonalAccessTokenResponse] | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.personal_access_tokens_api import PersonalAccessTokensApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.get_personal_access_token_response import GetPersonalAccessTokenResponse +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + owner_id = '2c9180867b50d088017b554662fb281e' # str | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) # str | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) + filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # 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: **lastUsed**: *le, isnull* (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: **lastUsed**: *le, isnull* (optional) + + try: + # List Personal Access Tokens + + results = PersonalAccessTokensApi(api_client).list_personal_access_tokens() + # Below is a request that includes all optional parameters + # results = PersonalAccessTokensApi(api_client).list_personal_access_tokens(owner_id, filters) + print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->list_personal_access_tokens: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-personal-access-token +Patch Personal Access Token +This performs a targeted update to the field(s) of a Personal Access Token. +Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-personal-access-token) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The Personal Access Token id + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope + +### Return type +[**GetPersonalAccessTokenResponse**](../models/get-personal-access-token-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Indicates the PATCH operation succeeded, and returns the PAT's new representation. | GetPersonalAccessTokenResponse | - | +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-patch+json + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2024.api.personal_access_tokens_api import PersonalAccessTokensApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.get_personal_access_token_response import GetPersonalAccessTokenResponse +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Personal Access Token id # str | The Personal Access Token id + json_patch_operation = '''[{op=replace, path=/name, value=New name}, {op=replace, path=/scope, value=[sp:scopes:all]}]''' # List[JsonPatchOperation] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope + + try: + # Patch Personal Access Token + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = PersonalAccessTokensApi(api_client).patch_personal_access_token(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = PersonalAccessTokensApi(api_client).patch_personal_access_token(id, new_json_patch_operation) + print("The response of PersonalAccessTokensApi->patch_personal_access_token:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->patch_personal_access_token: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/PublicIdentitiesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/PublicIdentitiesApi.md new file mode 100644 index 000000000..a40feb254 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/PublicIdentitiesApi.md @@ -0,0 +1,93 @@ +--- +id: v2024-public-identities +title: Public_Identities +pagination_label: Public_Identities +sidebar_label: Public_Identities +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Public_Identities', 'V2024Public_Identities'] +slug: /tools/sdk/python/v2024/methods/public-identities +tags: ['SDK', 'Software Development Kit', 'Public_Identities', 'V2024Public_Identities'] +--- + +# sailpoint.v2024.PublicIdentitiesApi + Use this API in conjunction with [Public Identites Config](https://developer.sailpoint.com/docs/api/v2024/public-identities-config/) to enable non-administrators to view identities' publicly visible attributes. +With this functionality in place, non-administrators can view identity attributes other than the default attributes (email, lifecycle state, and manager), depending on which identity attributes their organization administrators have made public. +This can be helpful for access approvers, certification reviewers, managers viewing their direct reports' access, and source owners viewing their tasks. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-public-identities**](#get-public-identities) | **GET** `/public-identities` | Get list of public identities + + +## get-public-identities +Get list of public identities +Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-public-identities) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + 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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* + Query | add_core_filters | **bool** | (optional) (default to False) | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. + Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** + +### Return type +[**List[PublicIdentity]**](../models/public-identity) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of public identity objects. | List[PublicIdentity] | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.public_identities_api import PublicIdentitiesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.public_identity import PublicIdentity +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + 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) + filters = 'firstname eq \"John\"' # 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: **id**: *eq, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (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: **id**: *eq, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (optional) + add_core_filters = False # bool | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to False) # bool | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to False) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + try: + # Get list of public identities + + results = PublicIdentitiesApi(api_client).get_public_identities() + # Below is a request that includes all optional parameters + # results = PublicIdentitiesApi(api_client).get_public_identities(limit, offset, count, filters, add_core_filters, sorters) + print("The response of PublicIdentitiesApi->get_public_identities:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PublicIdentitiesApi->get_public_identities: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/PublicIdentitiesConfigApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/PublicIdentitiesConfigApi.md new file mode 100644 index 000000000..84fc4efa9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/PublicIdentitiesConfigApi.md @@ -0,0 +1,159 @@ +--- +id: v2024-public-identities-config +title: Public_Identities_Config +pagination_label: Public_Identities_Config +sidebar_label: Public_Identities_Config +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Public_Identities_Config', 'V2024Public_Identities_Config'] +slug: /tools/sdk/python/v2024/methods/public-identities-config +tags: ['SDK', 'Software Development Kit', 'Public_Identities_Config', 'V2024Public_Identities_Config'] +--- + +# sailpoint.v2024.PublicIdentitiesConfigApi + Use this API to implement public identity configuration functionality. +With this functionality in place, administrators can make up to 5 identity attributes publicly visible so other non-administrator users can see the relevant information they need to make decisions. +This can be helpful for approvers making approvals, certification reviewers, managers viewing their direct reports' access, and source owners viewing their tasks. + +By default, non-administrators can select an identity and view the following attributes: email, lifecycle state, and manager. +However, it may be helpful for a non-administrator reviewer to see other identity attributes like department, region, title, etc. +Administrators can use this API to make those necessary identity attributes public to non-administrators. + +For example, a non-administrator deciding whether to approve another identity's request for access to the Workday application, whose access may be restricted to members of the HR department, would want to know whether the identity is a member of the HR department. +If an administrator has used [Update Public Identity Config](https://developer.sailpoint.com/docs/api/v2024/update-public-identity-config/) to make the "department" attribute public, the approver can see the department and make a decision without requesting any more information. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-public-identity-config**](#get-public-identity-config) | **GET** `/public-identities-config` | Get the Public Identities Configuration +[**update-public-identity-config**](#update-public-identity-config) | **PUT** `/public-identities-config` | Update the Public Identities Configuration + + +## get-public-identity-config +Get the Public Identities Configuration +Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-public-identity-config) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**PublicIdentityConfig**](../models/public-identity-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Request succeeded. | PublicIdentityConfig | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.public_identities_config_api import PublicIdentitiesConfigApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.public_identity_config import PublicIdentityConfig +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + + try: + # Get the Public Identities Configuration + + results = PublicIdentitiesConfigApi(api_client).get_public_identity_config() + # Below is a request that includes all optional parameters + # results = PublicIdentitiesConfigApi(api_client).get_public_identity_config() + print("The response of PublicIdentitiesConfigApi->get_public_identity_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PublicIdentitiesConfigApi->get_public_identity_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-public-identity-config +Update the Public Identities Configuration +Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-public-identity-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | public_identity_config | [**PublicIdentityConfig**](../models/public-identity-config) | True | + +### Return type +[**PublicIdentityConfig**](../models/public-identity-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Request succeeded. | PublicIdentityConfig | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.public_identities_config_api import PublicIdentitiesConfigApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.public_identity_config import PublicIdentityConfig +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + public_identity_config = '''{ + "modified" : "2018-06-25T20:22:28.104Z", + "attributes" : [ { + "name" : "Country", + "key" : "country" + }, { + "name" : "Country", + "key" : "country" + } ], + "modifiedBy" : { + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }''' # PublicIdentityConfig | + + try: + # Update the Public Identities Configuration + new_public_identity_config = PublicIdentityConfig.from_json(public_identity_config) + results = PublicIdentitiesConfigApi(api_client).update_public_identity_config(public_identity_config=new_public_identity_config) + # Below is a request that includes all optional parameters + # results = PublicIdentitiesConfigApi(api_client).update_public_identity_config(new_public_identity_config) + print("The response of PublicIdentitiesConfigApi->update_public_identity_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PublicIdentitiesConfigApi->update_public_identity_config: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ReportsDataExtractionApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ReportsDataExtractionApi.md new file mode 100644 index 000000000..08b8fee2c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ReportsDataExtractionApi.md @@ -0,0 +1,272 @@ +--- +id: v2024-reports-data-extraction +title: Reports_Data_Extraction +pagination_label: Reports_Data_Extraction +sidebar_label: Reports_Data_Extraction +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Reports_Data_Extraction', 'V2024Reports_Data_Extraction'] +slug: /tools/sdk/python/v2024/methods/reports-data-extraction +tags: ['SDK', 'Software Development Kit', 'Reports_Data_Extraction', 'V2024Reports_Data_Extraction'] +--- + +# sailpoint.v2024.ReportsDataExtractionApi + Use this API to implement reports lifecycle managing and monitoring. +With this functionality in place, users can run reports, view their results, and cancel reports in progress. +This can be potentially helpful for auditing purposes. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**cancel-report**](#cancel-report) | **POST** `/reports/{id}/cancel` | Cancel Report +[**get-report**](#get-report) | **GET** `/reports/{taskResultId}` | Get Report File +[**get-report-result**](#get-report-result) | **GET** `/reports/{taskResultId}/result` | Get Report Result +[**start-report**](#start-report) | **POST** `/reports/run` | Run Report + + +## cancel-report +Cancel Report +Cancels a running report. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/cancel-report) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the running Report to cancel + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +204 | No content - indicates the request was successful but there is no content to be returned in the response. | | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.reports_data_extraction_api import ReportsDataExtractionApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'a1ed223247144cc29d23c632624b4767' # str | ID of the running Report to cancel # str | ID of the running Report to cancel + + try: + # Cancel Report + + ReportsDataExtractionApi(api_client).cancel_report(id=id) + # Below is a request that includes all optional parameters + # ReportsDataExtractionApi(api_client).cancel_report(id) + except Exception as e: + print("Exception when calling ReportsDataExtractionApi->cancel_report: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-report +Get Report File +Gets a report in file format. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-report) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | task_result_id | **str** | True | Unique identifier of the task result which handled report + Query | file_format | **str** | True | Output format of the requested report file + Query | name | **str** | (optional) | preferred Report file name, by default will be used report name from task result. + Query | auditable | **bool** | (optional) (default to False) | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. + +### Return type +**bytearray** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Report file in selected format. CSV by default. | bytearray | * Content-disposition - The requested report's filename | +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/csv, application/pdf, application/json + +### Example + +```python +from sailpoint.v2024.api.reports_data_extraction_api import ReportsDataExtractionApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + task_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Unique identifier of the task result which handled report # str | Unique identifier of the task result which handled report + file_format = 'csv' # str | Output format of the requested report file # str | Output format of the requested report file + name = 'Identities Details Report' # str | preferred Report file name, by default will be used report name from task result. (optional) # str | preferred Report file name, by default will be used report name from task result. (optional) + auditable = False # bool | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to False) # bool | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to False) + + try: + # Get Report File + + results = ReportsDataExtractionApi(api_client).get_report(task_result_id=task_result_id, file_format=file_format) + # Below is a request that includes all optional parameters + # results = ReportsDataExtractionApi(api_client).get_report(task_result_id, file_format, name, auditable) + print("The response of ReportsDataExtractionApi->get_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ReportsDataExtractionApi->get_report: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-report-result +Get Report Result +Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-report-result) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | task_result_id | **str** | True | Unique identifier of the task result which handled report + Query | completed | **bool** | (optional) (default to False) | state of task result to apply ordering when results are fetching from the DB + +### Return type +[**ReportResults**](../models/report-results) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Details about report that was run or is running. | ReportResults | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.reports_data_extraction_api import ReportsDataExtractionApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.report_results import ReportResults +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + task_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Unique identifier of the task result which handled report # str | Unique identifier of the task result which handled report + completed = False # bool | state of task result to apply ordering when results are fetching from the DB (optional) (default to False) # bool | state of task result to apply ordering when results are fetching from the DB (optional) (default to False) + + try: + # Get Report Result + + results = ReportsDataExtractionApi(api_client).get_report_result(task_result_id=task_result_id) + # Below is a request that includes all optional parameters + # results = ReportsDataExtractionApi(api_client).get_report_result(task_result_id, completed) + print("The response of ReportsDataExtractionApi->get_report_result:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ReportsDataExtractionApi->get_report_result: %s\n" % e) +``` + + + +[[Back to top]](#) + +## start-report +Run Report +Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-report) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | report_details | [**ReportDetails**](../models/report-details) | True | + +### Return type +[**TaskResultDetails**](../models/task-result-details) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Details about running report task. | TaskResultDetails | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.reports_data_extraction_api import ReportsDataExtractionApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.report_details import ReportDetails +from sailpoint.v2024.models.task_result_details import TaskResultDetails +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + report_details = '''{ + "reportType" : "ACCOUNTS", + "arguments" : { + "application" : "2c9180897e7742b2017e781782f705b9", + "sourceName" : "Active Directory" + } + }''' # ReportDetails | + + try: + # Run Report + new_report_details = ReportDetails.from_json(report_details) + results = ReportsDataExtractionApi(api_client).start_report(report_details=new_report_details) + # Below is a request that includes all optional parameters + # results = ReportsDataExtractionApi(api_client).start_report(new_report_details) + print("The response of ReportsDataExtractionApi->start_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ReportsDataExtractionApi->start_report: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/RequestableObjectsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/RequestableObjectsApi.md new file mode 100644 index 000000000..0b673ac27 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/RequestableObjectsApi.md @@ -0,0 +1,102 @@ +--- +id: v2024-requestable-objects +title: Requestable_Objects +pagination_label: Requestable_Objects +sidebar_label: Requestable_Objects +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Requestable_Objects', 'V2024Requestable_Objects'] +slug: /tools/sdk/python/v2024/methods/requestable-objects +tags: ['SDK', 'Software Development Kit', 'Requestable_Objects', 'V2024Requestable_Objects'] +--- + +# sailpoint.v2024.RequestableObjectsApi + Use this API to implement requestable object functionality. +With this functionality in place, administrators can determine which access items can be requested with the [Access Request APIs](https://developer.sailpoint.com/docs/api/v2024/access-requests/), along with their statuses. +This can be helpful for administrators who are implementing and customizing access request functionality as a way of checking which items are requestable as they are created, assigned, and made available. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**list-requestable-objects**](#list-requestable-objects) | **GET** `/requestable-objects` | Requestable Objects List + + +## list-requestable-objects +Requestable Objects List +Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v2024/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. +Any authenticated token can call this endpoint to see their requestable access items. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-requestable-objects) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | identity_id | **str** | (optional) | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. + Query | types | [**[]RequestableObjectType**](../models/requestable-object-type) | (optional) | Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. + Query | term | **str** | (optional) | Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. + Query | statuses | [**[]RequestableObjectRequestStatus**](../models/requestable-object-request-status) | (optional) | Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + 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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* + Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** + +### Return type +[**List[RequestableObject]**](../models/requestable-object) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of requestable objects | List[RequestableObject] | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.requestable_objects_api import RequestableObjectsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.requestable_object import RequestableObject +from sailpoint.v2024.models.requestable_object_request_status import RequestableObjectRequestStatus +from sailpoint.v2024.models.requestable_object_type import RequestableObjectType +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + identity_id = 'e7eab60924f64aa284175b9fa3309599' # str | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) # str | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) + types = '''[sailpoint.v2024.RequestableObjectType()]''' # List[RequestableObjectType] | Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. (optional) + term = 'Finance Role' # str | Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. (optional) # str | Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. (optional) + statuses = '''[sailpoint.v2024.RequestableObjectRequestStatus()]''' # List[RequestableObjectRequestStatus] | Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. (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) + filters = 'name sw \"bob\"' # 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: **id**: *eq, in* **name**: *eq, in, sw* (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: **id**: *eq, in* **name**: *eq, in, sw* (optional) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + try: + # Requestable Objects List + + results = RequestableObjectsApi(api_client).list_requestable_objects() + # Below is a request that includes all optional parameters + # results = RequestableObjectsApi(api_client).list_requestable_objects(identity_id, types, term, statuses, limit, offset, count, filters, sorters) + print("The response of RequestableObjectsApi->list_requestable_objects:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/RoleInsightsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/RoleInsightsApi.md new file mode 100644 index 000000000..abe356c9a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/RoleInsightsApi.md @@ -0,0 +1,704 @@ +--- +id: v2024-role-insights +title: Role_Insights +pagination_label: Role_Insights +sidebar_label: Role_Insights +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Role_Insights', 'V2024Role_Insights'] +slug: /tools/sdk/python/v2024/methods/role-insights +tags: ['SDK', 'Software Development Kit', 'Role_Insights', 'V2024Role_Insights'] +--- + +# sailpoint.v2024.RoleInsightsApi + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-role-insight-requests**](#create-role-insight-requests) | **POST** `/role-insights/requests` | Generate insights for roles +[**download-role-insights-entitlements-changes**](#download-role-insights-entitlements-changes) | **GET** `/role-insights/{insightId}/entitlement-changes/download` | Download entitlement insights for a role +[**get-entitlement-changes-identities**](#get-entitlement-changes-identities) | **GET** `/role-insights/{insightId}/entitlement-changes/{entitlementId}/identities` | Get identities for a suggested entitlement (for a role) +[**get-role-insight**](#get-role-insight) | **GET** `/role-insights/{insightId}` | Get a single role insight +[**get-role-insights**](#get-role-insights) | **GET** `/role-insights` | Get role insights +[**get-role-insights-current-entitlements**](#get-role-insights-current-entitlements) | **GET** `/role-insights/{insightId}/current-entitlements` | Get current entitlement for a role +[**get-role-insights-entitlements-changes**](#get-role-insights-entitlements-changes) | **GET** `/role-insights/{insightId}/entitlement-changes` | Get entitlement insights for a role +[**get-role-insights-requests**](#get-role-insights-requests) | **GET** `/role-insights/requests/{id}` | Returns metadata from prior request. +[**get-role-insights-summary**](#get-role-insights-summary) | **GET** `/role-insights/summary` | Get role insights summary information + + +## create-role-insight-requests +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +Generate insights for roles +Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-role-insight-requests) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**RoleInsightsResponse**](../models/role-insights-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Submitted a role insights generation request | RoleInsightsResponse | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.role_insights_api import RoleInsightsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role_insights_response import RoleInsightsResponse +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + + try: + # Generate insights for roles + + results = RoleInsightsApi(api_client).create_role_insight_requests(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).create_role_insight_requests(x_sail_point_experimental) + print("The response of RoleInsightsApi->create_role_insight_requests:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RoleInsightsApi->create_role_insight_requests: %s\n" % e) +``` + + + +[[Back to top]](#) + +## download-role-insights-entitlements-changes +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +Download entitlement insights for a role +This endpoint returns the entitlement insights for a role. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/download-role-insights-entitlements-changes) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | insight_id | **str** | True | The role insight id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. + Query | filters | **str** | (optional) | 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: **name**: *sw* **description**: *sw* + +### Return type +**str** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns a csv file containing a list of entitlements to be added for a role. | 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. | ListAccessProfiles401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: text/csv, application/json + +### Example + +```python +from sailpoint.v2024.api.role_insights_api import RoleInsightsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sorters = 'identitiesWithAccess' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional) + filters = 'name sw \"r\"' # 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: **name**: *sw* **description**: *sw* (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: **name**: *sw* **description**: *sw* (optional) + + try: + # Download entitlement insights for a role + + results = RoleInsightsApi(api_client).download_role_insights_entitlements_changes(insight_id=insight_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).download_role_insights_entitlements_changes(insight_id, x_sail_point_experimental, sorters, filters) + print("The response of RoleInsightsApi->download_role_insights_entitlements_changes:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RoleInsightsApi->download_role_insights_entitlements_changes: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-entitlement-changes-identities +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +Get identities for a suggested entitlement (for a role) +Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-entitlement-changes-identities) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | insight_id | **str** | True | The role insight id +Path | entitlement_id | **str** | True | The entitlement id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Query | has_entitlement | **bool** | (optional) (default to False) | Identity has this entitlement or not + 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** + Query | filters | **str** | (optional) | 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: **name**: *sw* + +### Return type +[**List[RoleInsightsIdentities]**](../models/role-insights-identities) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns a list of identities with or without the entitlement. | List[RoleInsightsIdentities] | - | +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 | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2024.api.role_insights_api import RoleInsightsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role_insights_identities import RoleInsightsIdentities +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id + entitlement_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The entitlement id # str | The entitlement id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + has_entitlement = False # bool | Identity has this entitlement or not (optional) (default to False) # bool | Identity has this entitlement or not (optional) (default to False) + 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) + 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) + 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) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + filters = 'name sw \"Jan\"' # 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: **name**: *sw* (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: **name**: *sw* (optional) + + try: + # Get identities for a suggested entitlement (for a role) + + results = RoleInsightsApi(api_client).get_entitlement_changes_identities(insight_id=insight_id, entitlement_id=entitlement_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).get_entitlement_changes_identities(insight_id, entitlement_id, x_sail_point_experimental, has_entitlement, offset, limit, count, sorters, filters) + print("The response of RoleInsightsApi->get_entitlement_changes_identities:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_entitlement_changes_identities: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-role-insight +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +Get a single role insight +This endpoint gets role insights information for a role. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-insight) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | insight_id | **str** | True | The role insight id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**RoleInsight**](../models/role-insight) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns information about insights for a single role. | RoleInsight | - | +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 | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2024.api.role_insights_api import RoleInsightsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role_insight import RoleInsight +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + + try: + # Get a single role insight + + results = RoleInsightsApi(api_client).get_role_insight(insight_id=insight_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).get_role_insight(insight_id, x_sail_point_experimental) + print("The response of RoleInsightsApi->get_role_insight:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insight: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-role-insights +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +Get role insights +This method returns detailed role insights for each role. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-insights) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** + Query | filters | **str** | (optional) | 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: **name**: *sw* **ownerName**: *sw* **description**: *sw* + +### Return type +[**List[RoleInsight]**](../models/role-insight) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns a list of roles with information about insights for each role. | List[RoleInsight] | - | +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 | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2024.api.role_insights_api import RoleInsightsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role_insight import RoleInsight +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + 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) + 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) + sorters = 'numberOfUpdates' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) + filters = 'name sw \"John\"' # 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: **name**: *sw* **ownerName**: *sw* **description**: *sw* (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: **name**: *sw* **ownerName**: *sw* **description**: *sw* (optional) + + try: + # Get role insights + + results = RoleInsightsApi(api_client).get_role_insights(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).get_role_insights(x_sail_point_experimental, offset, limit, count, sorters, filters) + print("The response of RoleInsightsApi->get_role_insights:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-role-insights-current-entitlements +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +Get current entitlement for a role +This endpoint gets the entitlements for a role. The term "current" is to distinguish from the entitlement(s) an insight might recommend adding. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-insights-current-entitlements) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | insight_id | **str** | True | The role insight id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Query | filters | **str** | (optional) | 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: **name**: *sw* **description**: *sw* + +### Return type +[**List[RoleInsightsEntitlement]**](../models/role-insights-entitlement) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns a list of current or pre-existing entitlements for a role. | List[RoleInsightsEntitlement] | - | +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 | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2024.api.role_insights_api import RoleInsightsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role_insights_entitlement import RoleInsightsEntitlement +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + filters = 'name sw \"r\"' # 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: **name**: *sw* **description**: *sw* (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: **name**: *sw* **description**: *sw* (optional) + + try: + # Get current entitlement for a role + + results = RoleInsightsApi(api_client).get_role_insights_current_entitlements(insight_id=insight_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).get_role_insights_current_entitlements(insight_id, x_sail_point_experimental, filters) + print("The response of RoleInsightsApi->get_role_insights_current_entitlements:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights_current_entitlements: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-role-insights-entitlements-changes +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +Get entitlement insights for a role +This endpoint returns entitlement insights for a role. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-insights-entitlements-changes) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | insight_id | **str** | True | The role insight id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess, name** + Query | filters | **str** | (optional) | 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: **name**: *sw* **description**: *sw* + +### Return type +[**List[RoleInsightsEntitlementChanges]**](../models/role-insights-entitlement-changes) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns a list of entitlements to be added for a role. | List[RoleInsightsEntitlementChanges] | - | +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 | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2024.api.role_insights_api import RoleInsightsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role_insights_entitlement_changes import RoleInsightsEntitlementChanges +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sorters = 'sorters_example' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess, name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess, name** (optional) + filters = 'name sw \"Admin\"' # 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: **name**: *sw* **description**: *sw* (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: **name**: *sw* **description**: *sw* (optional) + + try: + # Get entitlement insights for a role + + results = RoleInsightsApi(api_client).get_role_insights_entitlements_changes(insight_id=insight_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).get_role_insights_entitlements_changes(insight_id, x_sail_point_experimental, sorters, filters) + print("The response of RoleInsightsApi->get_role_insights_entitlements_changes:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights_entitlements_changes: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-role-insights-requests +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +Returns metadata from prior request. +This endpoint returns details of a prior role insights request. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-insights-requests) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The role insights request id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**RoleInsightsResponse**](../models/role-insights-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns details of an earlier role insights request. | RoleInsightsResponse | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.role_insights_api import RoleInsightsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role_insights_response import RoleInsightsResponse +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insights request id # str | The role insights request id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + + try: + # Returns metadata from prior request. + + results = RoleInsightsApi(api_client).get_role_insights_requests(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).get_role_insights_requests(id, x_sail_point_experimental) + print("The response of RoleInsightsApi->get_role_insights_requests:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights_requests: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-role-insights-summary +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +Get role insights summary information +This method returns high level summary information for role insights for a customer. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-insights-summary) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**RoleInsightsSummary**](../models/role-insights-summary) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Succeeded. Returns high level counts. | RoleInsightsSummary | - | +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 | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2024.api.role_insights_api import RoleInsightsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role_insights_summary import RoleInsightsSummary +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + + try: + # Get role insights summary information + + results = RoleInsightsApi(api_client).get_role_insights_summary(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).get_role_insights_summary(x_sail_point_experimental) + print("The response of RoleInsightsApi->get_role_insights_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights_summary: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/RolesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/RolesApi.md new file mode 100644 index 000000000..c4deae00c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/RolesApi.md @@ -0,0 +1,1320 @@ +--- +id: v2024-roles +title: Roles +pagination_label: Roles +sidebar_label: Roles +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Roles', 'V2024Roles'] +slug: /tools/sdk/python/v2024/methods/roles +tags: ['SDK', 'Software Development Kit', 'Roles', 'V2024Roles'] +--- + +# sailpoint.v2024.RolesApi + Use this API to implement and customize role functionality. +With this functionality in place, administrators can create roles and configure them for use throughout Identity Security Cloud. +Identity Security Cloud can use established criteria to automatically assign the roles to qualified users. This enables users to get all the access they need quickly and securely and administrators to spend their time on other tasks. + +Entitlements represent the most granular level of access in Identity Security Cloud. +Access profiles represent the next level and often group entitlements. +Roles represent the broadest level of access and often group access profiles. + +For example, an Active Directory source in Identity Security Cloud can have multiple entitlements: the first, 'Employees,' may represent the access all employees have at the organization, and a second, 'Developers,' may represent the access all developers have at the organization. + +An administrator can then create a broader set of access in the form of an access profile, 'AD Developers' grouping the 'Employees' entitlement with the 'Developers' entitlement. + +An administrator can then create an even broader set of access in the form of a role grouping the 'AD Developers' access profile with another profile, 'GitHub Developers,' grouping entitlements for the GitHub source. + +When users only need Active Directory employee access, they can request access to the 'Employees' entitlement. + +When users need both Active Directory employee and developer access, they can request access to the 'AD Developers' access profile. + +When users need both the 'AD Developers' access profile and the 'GitHub Developers' access profile, they can request access to the role grouping both. + +Roles often represent positions within organizations. +For example, an organization's accountant can access all the tools the organization's accountants need with the 'Accountant' role. +If the accountant switches to engineering, a qualified member of the organization can quickly revoke the accountant's 'Accountant' access and grant access to the 'Engineer' role instead, granting access to all the tools the organization's engineers need. + +In Identity Security Cloud, adminstrators can use the Access drop-down menu and select Roles to view, configure, and delete existing roles, as well as create new ones. +Administrators can enable and disable the role, and they can also make the following configurations: + +- Manage Access: Manage the role's access by adding or removing access profiles. + +- Define Assignment: Define the criteria Identity Security Cloud uses to assign the role to identities. +Use the first option, 'Standard Criteria,' to provide specific criteria for assignment like specific account attributes, entitlements, or identity attributes. +Use the second, 'Identity List,' to specify the identities for assignment. + +- Access Requests: Configure roles to be requestable and establish an approval process for any requests that the role be granted or revoked. +Do not configure a role to be requestable without establishing a secure access request approval process for that role first. + +Refer to [Working with Roles](https://documentation.sailpoint.com/saas/help/access/roles.html) for more information about roles. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-role**](#create-role) | **POST** `/roles` | Create a Role +[**delete-bulk-roles**](#delete-bulk-roles) | **POST** `/roles/bulk-delete` | Delete Role(s) +[**delete-metadata-from-role-by-key-and-value**](#delete-metadata-from-role-by-key-and-value) | **DELETE** `/roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Remove a Metadata From Role. +[**delete-role**](#delete-role) | **DELETE** `/roles/{id}` | Delete a Role +[**get-bulk-update-status**](#get-bulk-update-status) | **GET** `/roles/access-model-metadata/bulk-update` | Get Bulk-Update Statuses +[**get-bulk-update-status-by-id**](#get-bulk-update-status-by-id) | **GET** `/roles/access-model-metadata/bulk-update/id` | Get Bulk-Update Status by ID +[**get-role**](#get-role) | **GET** `/roles/{id}` | Get a Role +[**get-role-assigned-identities**](#get-role-assigned-identities) | **GET** `/roles/{id}/assigned-identities` | List Identities assigned a Role +[**get-role-entitlements**](#get-role-entitlements) | **GET** `/roles/{id}/entitlements` | List Role's Entitlements +[**list-roles**](#list-roles) | **GET** `/roles` | List Roles +[**patch-role**](#patch-role) | **PATCH** `/roles/{id}` | Patch a specified Role +[**search-roles-by-filter**](#search-roles-by-filter) | **POST** `/roles/filter` | Filter Roles by Metadata +[**update-attribute-key-and-value-to-role**](#update-attribute-key-and-value-to-role) | **POST** `/roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Add a Metadata to Role. +[**update-roles-metadata-by-filter**](#update-roles-metadata-by-filter) | **POST** `/roles/access-model-metadata/bulk-update/filter` | Bulk-Update Roles' Metadata by Filters +[**update-roles-metadata-by-ids**](#update-roles-metadata-by-ids) | **POST** `/roles/access-model-metadata/bulk-update/ids` | Bulk-Update Roles' Metadata by ID +[**update-roles-metadata-by-query**](#update-roles-metadata-by-query) | **POST** `/roles/access-model-metadata/bulk-update/query` | Bulk-Update Roles' Metadata by Query + + +## create-role +Create a Role +This API creates a role. + +You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. + +In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. + +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-role) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | role | [**Role**](../models/role) | True | + +### Return type +[**Role**](../models/role) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Role created | Role | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.roles_api import RolesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role import Role +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + role = '''{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "dimensional" : false, + "created" : "2021-03-01T22:32:58.104Z", + "dimensionRefs" : [ { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + }, { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + } ], + "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", + "membership" : { + "identities" : [ { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } ], + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, + "type" : "IDENTITY_LIST" + }, + "enabled" : true, + "revocationRequestConfig" : { + "commentsRequired" : false, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : false + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "legacyMembershipInfo" : { + "type" : "IDENTITY_LIST" + }, + "accessRequestConfig" : { + "commentsRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "name" : "Role 2567", + "modified" : "2021-03-02T20:22:28.104Z", + "accessModelMetadata" : { + "attributes" : [ { + "key" : "iscPrivacy", + "name" : "Privacy", + "multiselect" : false, + "status" : "active", + "type" : "governance", + "objectTypes" : [ "all" ], + "description" : "Specifies the level of privacy associated with an access item.", + "values" : [ { + "value" : "public", + "name" : "Public", + "status" : "active" + } ] + } ] + }, + "id" : "2c918086749d78830174a1a40e121518", + "requestable" : true + }''' # Role | + + try: + # Create a Role + new_role = Role.from_json(role) + results = RolesApi(api_client).create_role(role=new_role) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).create_role(new_role) + print("The response of RolesApi->create_role:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RolesApi->create_role: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-bulk-roles +Delete Role(s) +This endpoint initiates a bulk deletion of one or more roles. +When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. +This endpoint can only bulk delete up to a limit of 50 roles per request. +A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-bulk-roles) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | role_bulk_delete_request | [**RoleBulkDeleteRequest**](../models/role-bulk-delete-request) | True | + +### Return type +[**TaskResultDto**](../models/task-result-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Returns an object with the id of the task performing the delete operation. | TaskResultDto | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.roles_api import RolesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role_bulk_delete_request import RoleBulkDeleteRequest +from sailpoint.v2024.models.task_result_dto import TaskResultDto +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + role_bulk_delete_request = '''{ + "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + }''' # RoleBulkDeleteRequest | + + try: + # Delete Role(s) + new_role_bulk_delete_request = RoleBulkDeleteRequest.from_json(role_bulk_delete_request) + results = RolesApi(api_client).delete_bulk_roles(role_bulk_delete_request=new_role_bulk_delete_request) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).delete_bulk_roles(new_role_bulk_delete_request) + print("The response of RolesApi->delete_bulk_roles:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RolesApi->delete_bulk_roles: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-metadata-from-role-by-key-and-value +Remove a Metadata From Role. +This API initialize a request to remove a single Access Model Metadata from a role by attribute key and value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-metadata-from-role-by-key-and-value) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The role's id. +Path | attribute_key | **str** | True | Technical name of the Attribute. +Path | attribute_value | **str** | True | Technical name of the Attribute Value. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Request accepted | | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.roles_api import RolesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = '2c91808c74ff913f0175097daa9d59cd' # str | The role's id. # str | The role's id. + attribute_key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. + attribute_value = 'public' # str | Technical name of the Attribute Value. # str | Technical name of the Attribute Value. + + try: + # Remove a Metadata From Role. + + RolesApi(api_client).delete_metadata_from_role_by_key_and_value(id=id, attribute_key=attribute_key, attribute_value=attribute_value) + # Below is a request that includes all optional parameters + # RolesApi(api_client).delete_metadata_from_role_by_key_and_value(id, attribute_key, attribute_value) + except Exception as e: + print("Exception when calling RolesApi->delete_metadata_from_role_by_key_and_value: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-role +Delete a Role +This API deletes a Role by its ID. + +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-role) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Role + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +204 | No content - indicates the request was successful but there is no content to be returned in the response. | | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.roles_api import RolesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role + + try: + # Delete a Role + + RolesApi(api_client).delete_role(id=id) + # Below is a request that includes all optional parameters + # RolesApi(api_client).delete_role(id) + except Exception as e: + print("Exception when calling RolesApi->delete_role: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-bulk-update-status +Get Bulk-Update Statuses +This API returns a list of all unfinished bulk update process status of the tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-bulk-update-status) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**List[RoleGetAllBulkUpdateResponse]**](../models/role-get-all-bulk-update-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | successfully get the status of all unfinished bulk updates request. | List[RoleGetAllBulkUpdateResponse] | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.roles_api import RolesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role_get_all_bulk_update_response import RoleGetAllBulkUpdateResponse +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + + try: + # Get Bulk-Update Statuses + + results = RolesApi(api_client).get_bulk_update_status() + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).get_bulk_update_status() + print("The response of RolesApi->get_bulk_update_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RolesApi->get_bulk_update_status: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-bulk-update-status-by-id +Get Bulk-Update Status by ID + +This API initial a request for one bulk update's status by bulk update Id returns the status of the bulk update process. +A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-bulk-update-status-by-id) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The Id of the bulk update task. + +### Return type +[**RoleBulkUpdateResponse**](../models/role-bulk-update-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | return if bulk update status could be found. | RoleBulkUpdateResponse | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.roles_api import RolesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role_bulk_update_response import RoleBulkUpdateResponse +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'c24359c389374d0fb8585698a2189e3d' # str | The Id of the bulk update task. # str | The Id of the bulk update task. + + try: + # Get Bulk-Update Status by ID + + results = RolesApi(api_client).get_bulk_update_status_by_id(id=id) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).get_bulk_update_status_by_id(id) + print("The response of RolesApi->get_bulk_update_status_by_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RolesApi->get_bulk_update_status_by_id: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-role +Get a Role +This API returns a Role by its ID. +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Role + +### Return type +[**Role**](../models/role) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of all Roles | Role | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.roles_api import RolesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role import Role +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role + + try: + # Get a Role + + results = RolesApi(api_client).get_role(id=id) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).get_role(id) + print("The response of RolesApi->get_role:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RolesApi->get_role: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-role-assigned-identities +List Identities assigned a Role + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-assigned-identities) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Role for which the assigned Identities are to be listed + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + 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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* + Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** + +### Return type +[**List[RoleIdentity]**](../models/role-identity) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of Identities assigned the Role | List[RoleIdentity] | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.roles_api import RolesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role_identity import RoleIdentity +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121e121518' # str | ID of the Role for which the assigned Identities are to be listed # str | ID of the Role for which the assigned Identities are to be listed + 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) + filters = 'name sw Joe' # 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: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (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: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) + sorters = 'aliasName,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) + + try: + # List Identities assigned a Role + + results = RolesApi(api_client).get_role_assigned_identities(id=id) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).get_role_assigned_identities(id, limit, offset, count, filters, sorters) + print("The response of RolesApi->get_role_assigned_identities:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-role-entitlements +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +List Role's Entitlements +Get a list of entitlements associated with a specified role. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-entitlements) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Containing role's ID. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Query | limit | **int** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* + Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** + +### Return type +[**List[Entitlement]**](../models/entitlement) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of Entitlements | List[Entitlement] | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.roles_api import RolesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.entitlement import Entitlement +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121919ecca' # str | Containing role's ID. # str | Containing role's ID. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + 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) + filters = 'attribute eq \"memberOf\"' # 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: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (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: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) + sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) + + try: + # List Role's Entitlements + + results = RolesApi(api_client).get_role_entitlements(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).get_role_entitlements(id, x_sail_point_experimental, limit, offset, count, filters, sorters) + print("The response of RolesApi->get_role_entitlements:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RolesApi->get_role_entitlements: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-roles +List Roles +This API returns a list of Roles. + +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-roles) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | for_subadmin | **str** | (optional) | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. + Query | limit | **int** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* + Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** + Query | for_segment_ids | **str** | (optional) | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. + Query | include_unsegmented | **bool** | (optional) (default to True) | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. + +### Return type +[**List[Role]**](../models/role) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of Roles | List[Role] | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.roles_api import RolesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role import Role +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + for_subadmin = '5168015d32f890ca15812c9180835d2e' # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + 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) + filters = 'requestable eq false' # 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: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (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: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) + sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + include_unsegmented = True # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) + + try: + # List Roles + + results = RolesApi(api_client).list_roles() + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).list_roles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) + print("The response of RolesApi->list_roles:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RolesApi->list_roles: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-role +Patch a specified Role +This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +The following fields are patchable: + +* name +* description +* enabled +* owner +* accessProfiles +* entitlements +* membership +* requestable +* accessRequestConfig +* revokeRequestConfig +* segments +* accessModelMetadata +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. + +When you use this API to modify a role's membership identities, you can only modify up to a limit of 500 membership identities at a time. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-role) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Role to patch + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | + +### Return type +[**Role**](../models/role) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with the Role as updated. | Role | - | +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 | - | +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-patch+json + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2024.api.roles_api import RolesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation +from sailpoint.v2024.models.role import Role +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121e121518' # str | ID of the Role to patch # str | ID of the Role to patch + json_patch_operation = '''[{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}]''' # List[JsonPatchOperation] | + + try: + # Patch a specified Role + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = RolesApi(api_client).patch_role(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).patch_role(id, new_json_patch_operation) + print("The response of RolesApi->patch_role:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RolesApi->patch_role: %s\n" % e) +``` + + + +[[Back to top]](#) + +## search-roles-by-filter +Filter Roles by Metadata +This API returns a list of Role that filter by metadata and filter, it support filter by both path parameter and attribute key and values. +A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, HELPDESK, CERT_ADMIN, REPORT_ADMIN or SOURCE_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-roles-by-filter) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | for_subadmin | **str** | (optional) | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. + Query | limit | **int** | (optional) (default to 50) | Max number of results to return See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** + Query | for_segment_ids | **str** | (optional) | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. + Query | include_unsegmented | **bool** | (optional) (default to True) | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. + Body | role_list_filter_dto | [**RoleListFilterDTO**](../models/role-list-filter-dto) | (optional) | + +### Return type +**Role** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with A list of Roles | Role[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. | ListAccessProfiles401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | 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 + +```python +from sailpoint.v2024.api.roles_api import RolesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role import Role +from sailpoint.v2024.models.role_list_filter_dto import RoleListFilterDTO +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + for_subadmin = '5168015d32f890ca15812c9180835d2e' # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + limit = 50 # 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 50) # 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 50) + 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) + sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + include_unsegmented = True # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) + role_list_filter_dto = '''{ + "ammKeyValues" : [ { + "attribute" : "iscFederalClassifications", + "values" : [ "secret" ] + } ], + "filters" : "dimensional eq false" + }''' # RoleListFilterDTO | (optional) + + try: + # Filter Roles by Metadata + + results = RolesApi(api_client).search_roles_by_filter() + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).search_roles_by_filter(for_subadmin, limit, offset, count, sorters, for_segment_ids, include_unsegmented, new_role_list_filter_dto) + print("The response of RolesApi->search_roles_by_filter:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RolesApi->search_roles_by_filter: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-attribute-key-and-value-to-role +Add a Metadata to Role. +This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-attribute-key-and-value-to-role) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The Id of a role +Path | attribute_key | **str** | True | Technical name of the Attribute. +Path | attribute_value | **str** | True | Technical name of the Attribute Value. + +### Return type +[**Role**](../models/role) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with the Role as updated. | Role | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.roles_api import RolesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role import Role +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'c24359c389374d0fb8585698a2189e3d' # str | The Id of a role # str | The Id of a role + attribute_key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. + attribute_value = 'public' # str | Technical name of the Attribute Value. # str | Technical name of the Attribute Value. + + try: + # Add a Metadata to Role. + + results = RolesApi(api_client).update_attribute_key_and_value_to_role(id=id, attribute_key=attribute_key, attribute_value=attribute_value) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).update_attribute_key_and_value_to_role(id, attribute_key, attribute_value) + print("The response of RolesApi->update_attribute_key_and_value_to_role:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RolesApi->update_attribute_key_and_value_to_role: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-roles-metadata-by-filter +Bulk-Update Roles' Metadata by Filters +This API initiates a bulk update of metadata for one or more Roles by filter. +A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. +The maximum metadata value count for a single role is 25. +Custom metadata update, including add, replace need suit licensed. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-roles-metadata-by-filter) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | role_metadata_bulk_update_by_filter_request | [**RoleMetadataBulkUpdateByFilterRequest**](../models/role-metadata-bulk-update-by-filter-request) | True | + +### Return type +[**RoleBulkUpdateResponse**](../models/role-bulk-update-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Returned if bulk update request created | RoleBulkUpdateResponse | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.roles_api import RolesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role_bulk_update_response import RoleBulkUpdateResponse +from sailpoint.v2024.models.role_metadata_bulk_update_by_filter_request import RoleMetadataBulkUpdateByFilterRequest +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + role_metadata_bulk_update_by_filter_request = '''{ + "values" : [ { + "attribute" : "iscFederalClassifications", + "values" : [ "topSecret" ] + } ], + "filters" : " requestable eq false", + "replaceScope" : "ALL", + "operation" : "REPLACE" + }''' # RoleMetadataBulkUpdateByFilterRequest | + + try: + # Bulk-Update Roles' Metadata by Filters + new_role_metadata_bulk_update_by_filter_request = RoleMetadataBulkUpdateByFilterRequest.from_json(role_metadata_bulk_update_by_filter_request) + results = RolesApi(api_client).update_roles_metadata_by_filter(role_metadata_bulk_update_by_filter_request=new_role_metadata_bulk_update_by_filter_request) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).update_roles_metadata_by_filter(new_role_metadata_bulk_update_by_filter_request) + print("The response of RolesApi->update_roles_metadata_by_filter:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RolesApi->update_roles_metadata_by_filter: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-roles-metadata-by-ids +Bulk-Update Roles' Metadata by ID +This API initiates a bulk update of metadata for one or more Roles by a list of Role Ids. +A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. +The maximum role count in a single update request is 3000. The maximum metadata value count for a single role is 25. +Custom metadata update, including add, replace need suit licensed. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-roles-metadata-by-ids) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | role_metadata_bulk_update_by_id_request | [**RoleMetadataBulkUpdateByIdRequest**](../models/role-metadata-bulk-update-by-id-request) | True | + +### Return type +[**RoleBulkUpdateResponse**](../models/role-bulk-update-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Returned if bulk update request created | RoleBulkUpdateResponse | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.roles_api import RolesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role_bulk_update_response import RoleBulkUpdateResponse +from sailpoint.v2024.models.role_metadata_bulk_update_by_id_request import RoleMetadataBulkUpdateByIdRequest +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + role_metadata_bulk_update_by_id_request = '''{ + "roles" : [ "b1db89554cfa431cb8b9921ea38d9367" ], + "values" : [ { + "attribute" : "iscFederalClassifications", + "values" : [ "topSecret" ] + } ], + "replaceScope" : "ALL", + "operation" : "REPLACE" + }''' # RoleMetadataBulkUpdateByIdRequest | + + try: + # Bulk-Update Roles' Metadata by ID + new_role_metadata_bulk_update_by_id_request = RoleMetadataBulkUpdateByIdRequest.from_json(role_metadata_bulk_update_by_id_request) + results = RolesApi(api_client).update_roles_metadata_by_ids(role_metadata_bulk_update_by_id_request=new_role_metadata_bulk_update_by_id_request) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).update_roles_metadata_by_ids(new_role_metadata_bulk_update_by_id_request) + print("The response of RolesApi->update_roles_metadata_by_ids:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RolesApi->update_roles_metadata_by_ids: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-roles-metadata-by-query +Bulk-Update Roles' Metadata by Query +This API initiates a bulk update of metadata for one or more Roles by query. +A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. +The maximum metadata value count for a single role is 25. +Custom metadata update, including add, replace need suit licensed. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-roles-metadata-by-query) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | role_metadata_bulk_update_by_query_request | [**RoleMetadataBulkUpdateByQueryRequest**](../models/role-metadata-bulk-update-by-query-request) | True | + +### Return type +[**RoleBulkUpdateResponse**](../models/role-bulk-update-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Returned if bulk update request created | RoleBulkUpdateResponse | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.roles_api import RolesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.role_bulk_update_response import RoleBulkUpdateResponse +from sailpoint.v2024.models.role_metadata_bulk_update_by_query_request import RoleMetadataBulkUpdateByQueryRequest +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + role_metadata_bulk_update_by_query_request = '''{ + "query" : { + "query\"" : { + "indices" : [ "roles" ], + "queryType" : "TEXT", + "textQuery" : { + "terms" : [ "test123" ], + "fields" : [ "id" ], + "matchAny" : false, + "contains" : true + }, + "includeNested" : false + } + }, + "values" : [ { + "attributeValue" : [ "topSecret" ], + "attributeKey" : "iscFederalClassifications" + }, { + "attributeValue" : [ "topSecret" ], + "attributeKey" : "iscFederalClassifications" + } ], + "replaceScope" : "ALL", + "operation" : "REPLACE" + }''' # RoleMetadataBulkUpdateByQueryRequest | + + try: + # Bulk-Update Roles' Metadata by Query + new_role_metadata_bulk_update_by_query_request = RoleMetadataBulkUpdateByQueryRequest.from_json(role_metadata_bulk_update_by_query_request) + results = RolesApi(api_client).update_roles_metadata_by_query(role_metadata_bulk_update_by_query_request=new_role_metadata_bulk_update_by_query_request) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).update_roles_metadata_by_query(new_role_metadata_bulk_update_by_query_request) + print("The response of RolesApi->update_roles_metadata_by_query:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RolesApi->update_roles_metadata_by_query: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SIMIntegrationsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SIMIntegrationsApi.md new file mode 100644 index 000000000..9030ea288 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SIMIntegrationsApi.md @@ -0,0 +1,605 @@ +--- +id: v2024-sim-integrations +title: SIM_Integrations +pagination_label: SIM_Integrations +sidebar_label: SIM_Integrations +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SIM_Integrations', 'V2024SIM_Integrations'] +slug: /tools/sdk/python/v2024/methods/sim-integrations +tags: ['SDK', 'Software Development Kit', 'SIM_Integrations', 'V2024SIM_Integrations'] +--- + +# sailpoint.v2024.SIMIntegrationsApi + Use this API to administer IdentityNow's Service Integration Module, or SIM integration with ServiceNow, so that it converts IdentityNow provisioning actions into tickets in ServiceNow. + +ServiceNow is a software platform that supports IT service management and automates common business processes for requesting and fulfilling service requests across a business enterprise. + +You must have an IdentityNow ServiceNow ServiceDesk license to use this integration. Contact your Customer Success Manager for more information. + +Service Desk integration for IdentityNow and in deprecation - not available for new implementation, as of July 21st, 2021. As per SailPoint’s [support policy](https://community.sailpoint.com/t5/Connector-Directory/SailPoint-Support-Policy-for-Connectivity/ta-p/79422), all existing SailPoint IdentityNow customers using this legacy integration will be supported until July 2022. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-sim-integration**](#create-sim-integration) | **POST** `/sim-integrations` | Create new SIM integration +[**delete-sim-integration**](#delete-sim-integration) | **DELETE** `/sim-integrations/{id}` | Delete a SIM integration +[**get-sim-integration**](#get-sim-integration) | **GET** `/sim-integrations/{id}` | Get a SIM integration details. +[**get-sim-integrations**](#get-sim-integrations) | **GET** `/sim-integrations` | List the existing SIM integrations. +[**patch-before-provisioning-rule**](#patch-before-provisioning-rule) | **PATCH** `/sim-integrations/{id}/beforeProvisioningRule` | Patch a SIM beforeProvisioningRule attribute. +[**patch-sim-attributes**](#patch-sim-attributes) | **PATCH** `/sim-integrations/{id}` | Patch a SIM attribute. +[**put-sim-integration**](#put-sim-integration) | **PUT** `/sim-integrations/{id}` | Update an existing SIM integration + + +## create-sim-integration +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +Create new SIM integration +Create a new SIM Integrations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-sim-integration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Body | sim_integration_details | [**SimIntegrationDetails**](../models/sim-integration-details) | True | DTO containing the details of the SIM integration + +### Return type +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | details of the created integration | ServiceDeskIntegrationDto | - | +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 + +```python +from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto +from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sim_integration_details = '''{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }''' # SimIntegrationDetails | DTO containing the details of the SIM integration + + try: + # Create new SIM integration + new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) + results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental, new_sim_integration_details) + print("The response of SIMIntegrationsApi->create_sim_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-sim-integration +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +Delete a SIM integration +Get the details of a SIM integration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-sim-integration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The id of the integration to delete. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | No content response | | - | +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 + +```python +from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + + try: + # Delete a SIM integration + + SIMIntegrationsApi(api_client).delete_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # SIMIntegrationsApi(api_client).delete_sim_integration(id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-sim-integration +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +Get a SIM integration details. +Get the details of a SIM integration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sim-integration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The id of the integration. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The DTO containing the details of the SIM integration | ServiceDeskIntegrationDto | - | +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 + +```python +from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration. # str | The id of the integration. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + + try: + # Get a SIM integration details. + + results = SIMIntegrationsApi(api_client).get_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).get_sim_integration(id, x_sail_point_experimental) + print("The response of SIMIntegrationsApi->get_sim_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-sim-integrations +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +List the existing SIM integrations. +List the existing SIM integrations. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sim-integrations) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**List[ServiceDeskIntegrationDto]**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The DTO containing the details of the SIM integration | List[ServiceDeskIntegrationDto] | - | +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 + +```python +from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + + try: + # List the existing SIM integrations. + + results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) + print("The response of SIMIntegrationsApi->get_sim_integrations:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-before-provisioning-rule +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +Patch a SIM beforeProvisioningRule attribute. +Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-before-provisioning-rule) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | SIM integration id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Body | json_patch | [**JsonPatch**](../models/json-patch) | True | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. + +### Return type +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The updated DTO containing the details of the SIM integration. | ServiceDeskIntegrationDto | - | +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-patch+json + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.json_patch import JsonPatch +from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + id = '12345' # str | SIM integration id # str | SIM integration id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. + + try: + # Patch a SIM beforeProvisioningRule attribute. + new_json_patch = JsonPatch.from_json(json_patch) + results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, x_sail_point_experimental, new_json_patch) + print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-sim-attributes +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +Patch a SIM attribute. +Patch a SIM attribute given a JsonPatch object. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-sim-attributes) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | SIM integration id + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Body | json_patch | [**JsonPatch**](../models/json-patch) | True | The JsonPatch object that describes the changes of SIM + +### Return type +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The updated DTO containing the details of the SIM integration. | ServiceDeskIntegrationDto | - | +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-patch+json + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.json_patch import JsonPatch +from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + id = '12345' # str | SIM integration id # str | SIM integration id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JsonPatch object that describes the changes of SIM + + try: + # Patch a SIM attribute. + new_json_patch = JsonPatch.from_json(json_patch) + results = SIMIntegrationsApi(api_client).patch_sim_attributes(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).patch_sim_attributes(id, x_sail_point_experimental, new_json_patch) + print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-sim-integration +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +Update an existing SIM integration +Update an existing SIM integration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-sim-integration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The id of the integration. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Body | sim_integration_details | [**SimIntegrationDetails**](../models/sim-integration-details) | True | The full DTO of the integration containing the updated model + +### Return type +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | details of the updated integration | ServiceDeskIntegrationDto | - | +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 + +```python +from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto +from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration. # str | The id of the integration. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sim_integration_details = '''{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }''' # SimIntegrationDetails | The full DTO of the integration containing the updated model + + try: + # Update an existing SIM integration + new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) + results = SIMIntegrationsApi(api_client).put_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).put_sim_integration(id, x_sail_point_experimental, new_sim_integration_details) + print("The response of SIMIntegrationsApi->put_sim_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SODPoliciesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SODPoliciesApi.md new file mode 100644 index 000000000..526cd72d5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SODPoliciesApi.md @@ -0,0 +1,1272 @@ +--- +id: v2024-sod-policies +title: SOD_Policies +pagination_label: SOD_Policies +sidebar_label: SOD_Policies +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SOD_Policies', 'V2024SOD_Policies'] +slug: /tools/sdk/python/v2024/methods/sod-policies +tags: ['SDK', 'Software Development Kit', 'SOD_Policies', 'V2024SOD_Policies'] +--- + +# sailpoint.v2024.SODPoliciesApi + Use this API to implement and manage "separation of duties" (SOD) policies. +With SOD policy functionality in place, administrators can organize the access in their tenants to prevent individuals from gaining conflicting or excessive access. + +"Separation of duties" refers to the concept that people shouldn't have conflicting sets of access - all their access should be configured in a way that protects your organization's assets and data. +For example, people who record monetary transactions shouldn't be able to issue payment for those transactions. +Any changes to major system configurations should be approved by someone other than the person requesting the change. + +Organizations can use "separation of duties" (SOD) policies to enforce and track their internal security rules throughout their tenants. +These SOD policies limit each user's involvement in important processes and protects the organization from individuals gaining excessive access. + +To create SOD policies in Identity Security Cloud, administrators use 'Search' and then access 'Policies'. +To create a policy, they must configure two lists of access items. Each access item can only be added to one of the two lists. +They can search for the entitlements they want to add to these access lists. + +>Note: You can have a maximum of 500 policies of any type (including general policies) in your organization. In each access-based SOD policy, you can have a maximum of 50 entitlements in each access list. + +Once a SOD policy is in place, if an identity has access items on both lists, a SOD violation will trigger. +These violations are included in SOD violation reports that other users will see in emails at regular intervals if they're subscribed to the SOD policy. +The other users can then better help to enforce these SOD policies. + +To create a subscription to a SOD policy in Identity Security Cloud, administrators use 'Search' and then access 'Layers'. +They can create a subscription to the policy and schedule it to run at a regular interval. + +Refer to [Managing Policies](https://documentation.sailpoint.com/saas/help/sod/manage-policies.html) for more information about SOD policies. + +Refer to [Subscribe to a SOD Policy](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html#subscribe-to-an-sod-policy) for more information about SOD policy subscriptions. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-sod-policy**](#create-sod-policy) | **POST** `/sod-policies` | Create SOD policy +[**delete-sod-policy**](#delete-sod-policy) | **DELETE** `/sod-policies/{id}` | Delete SOD policy by ID +[**delete-sod-policy-schedule**](#delete-sod-policy-schedule) | **DELETE** `/sod-policies/{id}/schedule` | Delete SOD policy schedule +[**get-custom-violation-report**](#get-custom-violation-report) | **GET** `/sod-violation-report/{reportResultId}/download/{fileName}` | Download custom violation report +[**get-default-violation-report**](#get-default-violation-report) | **GET** `/sod-violation-report/{reportResultId}/download` | Download violation report +[**get-sod-all-report-run-status**](#get-sod-all-report-run-status) | **GET** `/sod-violation-report` | Get multi-report run task status +[**get-sod-policy**](#get-sod-policy) | **GET** `/sod-policies/{id}` | Get SOD policy by ID +[**get-sod-policy-schedule**](#get-sod-policy-schedule) | **GET** `/sod-policies/{id}/schedule` | Get SOD policy schedule +[**get-sod-violation-report-run-status**](#get-sod-violation-report-run-status) | **GET** `/sod-policies/sod-violation-report-status/{reportResultId}` | Get violation report run status +[**get-sod-violation-report-status**](#get-sod-violation-report-status) | **GET** `/sod-policies/{id}/violation-report` | Get SOD violation report status +[**list-sod-policies**](#list-sod-policies) | **GET** `/sod-policies` | List SOD policies +[**patch-sod-policy**](#patch-sod-policy) | **PATCH** `/sod-policies/{id}` | Patch SOD policy by ID +[**put-policy-schedule**](#put-policy-schedule) | **PUT** `/sod-policies/{id}/schedule` | Update SOD Policy schedule +[**put-sod-policy**](#put-sod-policy) | **PUT** `/sod-policies/{id}` | Update SOD policy by ID +[**start-evaluate-sod-policy**](#start-evaluate-sod-policy) | **POST** `/sod-policies/{id}/evaluate` | Evaluate one policy by ID +[**start-sod-all-policies-for-org**](#start-sod-all-policies-for-org) | **POST** `/sod-violation-report/run` | Runs all policies for org +[**start-sod-policy**](#start-sod-policy) | **POST** `/sod-policies/{id}/violation-report/run` | Runs SOD policy violation report + + +## create-sod-policy +Create SOD policy +This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-sod-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | sod_policy | [**SodPolicy**](../models/sod-policy) | True | + +### Return type +[**SodPolicy**](../models/sod-policy) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | SOD policy created | SodPolicy | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.sod_policy import SodPolicy +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + + try: + # Create SOD policy + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) + print("The response of SODPoliciesApi->create_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-sod-policy +Delete SOD policy by ID +This deletes a specified SOD policy. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-sod-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the SOD Policy to delete. + Query | logical | **bool** | (optional) (default to True) | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. + +### 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. | 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 + +```python +from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. + logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) + + try: + # Delete SOD policy by ID + + SODPoliciesApi(api_client).delete_sod_policy(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy(id, logical) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-sod-policy-schedule +Delete SOD policy schedule +This deletes schedule for a specified SOD policy by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-sod-policy-schedule) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the SOD policy the schedule must be deleted for. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +204 | No content response. | | - | +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 + +```python +from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. + + try: + # Delete SOD policy schedule + + SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-custom-violation-report +Download custom violation report +This allows to download a specified named violation report for a given report reference. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-custom-violation-report) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | report_result_id | **str** | True | The ID of the report reference to download. +Path | file_name | **str** | True | Custom Name for the file. + +### Return type +**bytearray** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns the zip file with given custom name that contains the violation report file. | bytearray | - | +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/zip, application/json + +### Example + +```python +from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. + + try: + # Download custom violation report + + results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) + print("The response of SODPoliciesApi->get_custom_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-default-violation-report +Download violation report +This allows to download a violation report for a given report reference. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-default-violation-report) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | report_result_id | **str** | True | The ID of the report reference to download. + +### Return type +**bytearray** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns the PolicyReport.zip that contains the violation report file. | bytearray | - | +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/zip, application/json + +### Example + +```python +from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + + try: + # Download violation report + + results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) + print("The response of SODPoliciesApi->get_default_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-sod-all-report-run-status +Get multi-report run task status +This endpoint gets the status for a violation report for all policy run. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sod-all-report-run-status) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**ReportResultReference**](../models/report-result-reference) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Status of the violation report run task for all policy run. | ReportResultReference | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.report_result_reference import ReportResultReference +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + + try: + # Get multi-report run task status + + results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-sod-policy +Get SOD policy by ID +This gets specified SOD policy. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sod-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the SOD Policy to retrieve. + +### Return type +[**SodPolicy**](../models/sod-policy) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | SOD policy ID. | SodPolicy | - | +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 + +```python +from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.sod_policy import SodPolicy +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. + + try: + # Get SOD policy by ID + + results = SODPoliciesApi(api_client).get_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy(id) + print("The response of SODPoliciesApi->get_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-sod-policy-schedule +Get SOD policy schedule +This endpoint gets a specified SOD policy's schedule. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sod-policy-schedule) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the SOD policy schedule to retrieve. + +### Return type +[**SodPolicySchedule**](../models/sod-policy-schedule) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | SOD policy schedule. | SodPolicySchedule | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.sod_policy_schedule import SodPolicySchedule +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. + + try: + # Get SOD policy schedule + + results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) + print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-sod-violation-report-run-status +Get violation report run status +This gets the status for a violation report run task that has already been invoked. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sod-violation-report-run-status) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | report_result_id | **str** | True | The ID of the report reference to retrieve. + +### Return type +[**ReportResultReference**](../models/report-result-reference) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Status of the violation report run task. | ReportResultReference | - | +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 + +```python +from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.report_result_reference import ReportResultReference +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. + + try: + # Get violation report run status + + results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) + print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-sod-violation-report-status +Get SOD violation report status +This gets the status for a violation report run task that has already been invoked. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sod-violation-report-status) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the violation report to retrieve status for. + +### Return type +[**ReportResultReference**](../models/report-result-reference) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Status of the violation report run task. | ReportResultReference | - | +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 + +```python +from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.report_result_reference import ReportResultReference +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. + + try: + # Get SOD violation report status + + results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) + print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-sod-policies +List SOD policies +This gets list of all SOD policies. +Requires role of ORG_ADMIN + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-sod-policies) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + 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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* + Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** + +### Return type +[**List[SodPolicy]**](../models/sod-policy) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of all SOD policies. | List[SodPolicy] | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.sod_policy import SodPolicy +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + 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) + filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # 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: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (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: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + + try: + # List SOD policies + + results = SODPoliciesApi(api_client).list_sod_policies() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) + print("The response of SODPoliciesApi->list_sod_policies:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-sod-policy +Patch SOD policy by ID +Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +Requires role of ORG_ADMIN. +This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-sod-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the SOD policy being modified. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + +### Return type +[**SodPolicy**](../models/sod-policy) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Indicates the PATCH operation succeeded, and returns the SOD policy's new representation. | SodPolicy | - | +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-patch+json + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation +from sailpoint.v2024.models.sod_policy import SodPolicy +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. + json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + + try: + # Patch SOD policy by ID + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) + print("The response of SODPoliciesApi->patch_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-policy-schedule +Update SOD Policy schedule +This updates schedule for a specified SOD policy. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-policy-schedule) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the SOD policy to update its schedule. + Body | sod_policy_schedule | [**SodPolicySchedule**](../models/sod-policy-schedule) | True | + +### Return type +[**SodPolicySchedule**](../models/sod-policy-schedule) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Created or updated SOD policy schedule. | SodPolicySchedule | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.sod_policy_schedule import SodPolicySchedule +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. + sod_policy_schedule = '''{ + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + }''' # SodPolicySchedule | + + try: + # Update SOD Policy schedule + new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) + results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) + print("The response of SODPoliciesApi->put_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-sod-policy +Update SOD policy by ID +This updates a specified SOD policy. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-sod-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the SOD policy to update. + Body | sod_policy | [**SodPolicy**](../models/sod-policy) | True | + +### Return type +[**SodPolicy**](../models/sod-policy) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | SOD Policy by ID | SodPolicy | - | +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 + +```python +from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.sod_policy import SodPolicy +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + + try: + # Update SOD policy by ID + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) + print("The response of SODPoliciesApi->put_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) +``` + + + +[[Back to top]](#) + +## start-evaluate-sod-policy +Evaluate one policy by ID +Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-evaluate-sod-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The SOD policy ID to run. + +### Return type +[**ReportResultReference**](../models/report-result-reference) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Reference to the violation report run task. | ReportResultReference | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.report_result_reference import ReportResultReference +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + + try: + # Evaluate one policy by ID + + results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) + print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) +``` + + + +[[Back to top]](#) + +## start-sod-all-policies-for-org +Runs all policies for org +Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-sod-all-policies-for-org) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | multi_policy_request | [**MultiPolicyRequest**](../models/multi-policy-request) | (optional) | + +### Return type +[**ReportResultReference**](../models/report-result-reference) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Reference to the violation report run task. | ReportResultReference | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.multi_policy_request import MultiPolicyRequest +from sailpoint.v2024.models.report_result_reference import ReportResultReference +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + multi_policy_request = '''{ + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + }''' # MultiPolicyRequest | (optional) + + try: + # Runs all policies for org + + results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) + print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) +``` + + + +[[Back to top]](#) + +## start-sod-policy +Runs SOD policy violation report +This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-sod-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The SOD policy ID to run. + +### Return type +[**ReportResultReference**](../models/report-result-reference) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Reference to the violation report run task. | ReportResultReference | - | +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 + +```python +from sailpoint.v2024.api.sod_policies_api import SODPoliciesApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.report_result_reference import ReportResultReference +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + + try: + # Runs SOD policy violation report + + results = SODPoliciesApi(api_client).start_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_policy(id) + print("The response of SODPoliciesApi->start_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SODViolationsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SODViolationsApi.md new file mode 100644 index 000000000..3bf549cdf --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SODViolationsApi.md @@ -0,0 +1,172 @@ +--- +id: v2024-sod-violations +title: SOD_Violations +pagination_label: SOD_Violations +sidebar_label: SOD_Violations +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SOD_Violations', 'V2024SOD_Violations'] +slug: /tools/sdk/python/v2024/methods/sod-violations +tags: ['SDK', 'Software Development Kit', 'SOD_Violations', 'V2024SOD_Violations'] +--- + +# sailpoint.v2024.SODViolationsApi + Use this API to check for current "separation of duties" (SOD) policy violations as well as potential future SOD policy violations. +With SOD violation functionality in place, administrators can get information about current SOD policy violations and predict whether an access change will trigger new violations, which helps to prevent them from occurring at all. + +"Separation of duties" refers to the concept that people shouldn't have conflicting sets of access - all their access should be configured in a way that protects your organization's assets and data. +For example, people who record monetary transactions shouldn't be able to issue payment for those transactions. +Any changes to major system configurations should be approved by someone other than the person requesting the change. + +Organizations can use "separation of duties" (SOD) policies to enforce and track their internal security rules throughout their tenants. +These SOD policies limit each user's involvement in important processes and protects the organization from individuals gaining excessive access. + +Once a SOD policy is in place, if an identity has conflicting access items, a SOD violation will trigger. +These violations are included in SOD violation reports that other users will see in emails at regular intervals if they're subscribed to the SOD policy. +The other users can then better help to enforce these SOD policies. + +Administrators can use the SOD violations APIs to check a set of identities for any current SOD violations, and they can use them to check whether adding an access item would potentially trigger a SOD violation. +This second option is a good way to prevent SOD violations from triggering at all. + +Refer to [Handling Policy Violations](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html) for more information about SOD policy violations. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**start-predict-sod-violations**](#start-predict-sod-violations) | **POST** `/sod-violations/predict` | Predict SOD violations for identity. +[**start-violation-check**](#start-violation-check) | **POST** `/sod-violations/check` | Check SOD violations + + +## start-predict-sod-violations +Predict SOD violations for identity. +This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-predict-sod-violations) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | identity_with_new_access | [**IdentityWithNewAccess**](../models/identity-with-new-access) | True | + +### Return type +[**ViolationPrediction**](../models/violation-prediction) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Violation Contexts | ViolationPrediction | - | +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 + +```python +from sailpoint.v2024.api.sod_violations_api import SODViolationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.identity_with_new_access import IdentityWithNewAccess +from sailpoint.v2024.models.violation_prediction import ViolationPrediction +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + identity_with_new_access = '''{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + }''' # IdentityWithNewAccess | + + try: + # Predict SOD violations for identity. + new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) + results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) + print("The response of SODViolationsApi->start_predict_sod_violations:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) +``` + + + +[[Back to top]](#) + +## start-violation-check +Check SOD violations +This API initiates a SOD policy verification asynchronously. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-violation-check) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | identity_with_new_access1 | [**IdentityWithNewAccess1**](../models/identity-with-new-access1) | True | + +### Return type +[**SodViolationCheck**](../models/sod-violation-check) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Request ID with a timestamp. | SodViolationCheck | - | +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 + +```python +from sailpoint.v2024.api.sod_violations_api import SODViolationsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.identity_with_new_access1 import IdentityWithNewAccess1 +from sailpoint.v2024.models.sod_violation_check import SodViolationCheck +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | + + try: + # Check SOD violations + new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) + results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) + print("The response of SODViolationsApi->start_violation_check:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SPConfigApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SPConfigApi.md new file mode 100644 index 000000000..039ce6698 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SPConfigApi.md @@ -0,0 +1,466 @@ +--- +id: v2024-sp-config +title: SP_Config +pagination_label: SP_Config +sidebar_label: SP_Config +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SP_Config', 'V2024SP_Config'] +slug: /tools/sdk/python/v2024/methods/sp-config +tags: ['SDK', 'Software Development Kit', 'SP_Config', 'V2024SP_Config'] +--- + +# sailpoint.v2024.SPConfigApi + Import and export configuration for some objects between tenants. +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**export-sp-config**](#export-sp-config) | **POST** `/sp-config/export` | Initiates configuration objects export job +[**get-sp-config-export**](#get-sp-config-export) | **GET** `/sp-config/export/{id}/download` | Download export job result. +[**get-sp-config-export-status**](#get-sp-config-export-status) | **GET** `/sp-config/export/{id}` | Get export job status +[**get-sp-config-import**](#get-sp-config-import) | **GET** `/sp-config/import/{id}/download` | Download import job result +[**get-sp-config-import-status**](#get-sp-config-import-status) | **GET** `/sp-config/import/{id}` | Get import job status +[**import-sp-config**](#import-sp-config) | **POST** `/sp-config/import` | Initiates configuration objects import job +[**list-sp-config-objects**](#list-sp-config-objects) | **GET** `/sp-config/config-objects` | Get config object details + + +## export-sp-config +Initiates configuration objects export job +This post will export objects from the tenant to a JSON configuration file. +For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects). + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/export-sp-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | export_payload | [**ExportPayload**](../models/export-payload) | True | Export options control what will be included in the export. + +### Return type +[**SpConfigExportJob**](../models/sp-config-export-job) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Export job accepted and queued for processing. | SpConfigExportJob | - | +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 + +```python +from sailpoint.v2024.api.sp_config_api import SPConfigApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.export_payload import ExportPayload +from sailpoint.v2024.models.sp_config_export_job import SpConfigExportJob +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + export_payload = '''{ + "description" : "Export Job 1 Test" + }''' # ExportPayload | Export options control what will be included in the export. + + try: + # Initiates configuration objects export job + new_export_payload = ExportPayload.from_json(export_payload) + results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).export_sp_config(new_export_payload) + print("The response of SPConfigApi->export_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-sp-config-export +Download export job result. +This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file. +The request will need one of the following security scopes: +- sp:config:read - sp:config:manage + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sp-config-export) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the export job whose results will be downloaded. + +### Return type +[**SpConfigExportResults**](../models/sp-config-export-results) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Exported JSON objects. | SpConfigExportResults | - | +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 + +```python +from sailpoint.v2024.api.sp_config_api import SPConfigApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.sp_config_export_results import SpConfigExportResults +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. + + try: + # Download export job result. + + results = SPConfigApi(api_client).get_sp_config_export(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export(id) + print("The response of SPConfigApi->get_sp_config_export:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-sp-config-export-status +Get export job status +This gets the status of the export job identified by the `id` parameter. +The request will need one of the following security scopes: +- sp:config:read - sp:config:manage + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sp-config-export-status) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the export job whose status will be returned. + +### Return type +[**SpConfigExportJobStatus**](../models/sp-config-export-job-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Export job status successfully returned. | SpConfigExportJobStatus | - | +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 + +```python +from sailpoint.v2024.api.sp_config_api import SPConfigApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.sp_config_export_job_status import SpConfigExportJobStatus +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. + + try: + # Get export job status + + results = SPConfigApi(api_client).get_sp_config_export_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export_status(id) + print("The response of SPConfigApi->get_sp_config_export_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-sp-config-import +Download import job result +This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. +The request will need the following security scope: +- sp:config:manage + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sp-config-import) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the import job whose results will be downloaded. + +### Return type +[**SpConfigImportResults**](../models/sp-config-import-results) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Import results JSON object, containing detailed results of the import operation. | SpConfigImportResults | - | +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 + +```python +from sailpoint.v2024.api.sp_config_api import SPConfigApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.sp_config_import_results import SpConfigImportResults +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. + + try: + # Download import job result + + results = SPConfigApi(api_client).get_sp_config_import(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import(id) + print("The response of SPConfigApi->get_sp_config_import:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-sp-config-import-status +Get import job status +'This gets the status of the import job identified by the `id` parameter. + + For more information about the object types that currently support import functionality, + refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).' + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sp-config-import-status) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the import job whose status will be returned. + +### Return type +[**SpConfigImportJobStatus**](../models/sp-config-import-job-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Import job status successfully returned. | SpConfigImportJobStatus | - | +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 + +```python +from sailpoint.v2024.api.sp_config_api import SPConfigApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.sp_config_import_job_status import SpConfigImportJobStatus +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. + + try: + # Get import job status + + results = SPConfigApi(api_client).get_sp_config_import_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import_status(id) + print("The response of SPConfigApi->get_sp_config_import_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) +``` + + + +[[Back to top]](#) + +## import-sp-config +Initiates configuration objects import job +This post will import objects from a JSON configuration file into a tenant. +By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. +The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. +The backup can be skipped by setting "excludeBackup" to true in the import options. +If a backup is performed, the id of the backup will be provided in the ImportResult as the "exportJobId". This can be downloaded +using the `/sp-config/export/{exportJobId}/download` endpoint. + +You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. + +For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects). + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-sp-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | data | **bytearray** | True | JSON file containing the objects to be imported. + Query | preview | **bool** | (optional) (default to False) | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. + | options | [**ImportOptions**](../models/import-options) | (optional) | + +### Return type +[**SpConfigJob**](../models/sp-config-job) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Import job accepted and queued for processing. | SpConfigJob | - | +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**: multipart/form-data + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2024.api.sp_config_api import SPConfigApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.import_options import ImportOptions +from sailpoint.v2024.models.sp_config_job import SpConfigJob +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. + preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) + options = '''sailpoint.v2024.ImportOptions()''' # ImportOptions | (optional) + + try: + # Initiates configuration objects import job + + results = SPConfigApi(api_client).import_sp_config(data=data) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).import_sp_config(data, preview, options) + print("The response of SPConfigApi->import_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-sp-config-objects +Get config object details +This gets the list of object configurations which are known to the tenant export/import service. Object configurations that contain "importUrl" and "exportUrl" are available for export/import. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-sp-config-objects) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**List[SpConfigObject]**](../models/sp-config-object) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Object configurations returned successfully. | List[SpConfigObject] | - | +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 + +```python +from sailpoint.v2024.api.sp_config_api import SPConfigApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.sp_config_object import SpConfigObject +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + + try: + # Get config object details + + results = SPConfigApi(api_client).list_sp_config_objects() + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).list_sp_config_objects() + print("The response of SPConfigApi->list_sp_config_objects:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SavedSearchApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SavedSearchApi.md new file mode 100644 index 000000000..f1901d396 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SavedSearchApi.md @@ -0,0 +1,456 @@ +--- +id: v2024-saved-search +title: Saved_Search +pagination_label: Saved_Search +sidebar_label: Saved_Search +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Saved_Search', 'V2024Saved_Search'] +slug: /tools/sdk/python/v2024/methods/saved-search +tags: ['SDK', 'Software Development Kit', 'Saved_Search', 'V2024Saved_Search'] +--- + +# sailpoint.v2024.SavedSearchApi + Use this API to implement saved search functionality. +With saved search functionality in place, users can save search queries and then view those saved searches, as well as rerun them. + +Search queries in Identity Security Cloud can grow very long and specific, which can make reconstructing them difficult or tedious, so it can be especially helpful to save search queries. +It also opens the possibility to configure Identity Security Cloud to run the saved queries on a schedule, which is essential to detecting user information and access changes throughout an organization's tenant and across all its sources. +Refer to [Scheduled Search](https://developer.sailpoint.com/docs/api/v2024/scheduled-search/) for more information about running saved searches on a schedule. + +In Identity Security Cloud, users can save searches under a name, and then they can access that saved search and run it again when they want. + +Refer to [Managing Saved Searches](https://documentation.sailpoint.com/saas/help/search/saved-searches.html) for more information about saving searches and using them. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-saved-search**](#create-saved-search) | **POST** `/saved-searches` | Create a saved search +[**delete-saved-search**](#delete-saved-search) | **DELETE** `/saved-searches/{id}` | Delete document by ID +[**execute-saved-search**](#execute-saved-search) | **POST** `/saved-searches/{id}/execute` | Execute a saved search by ID +[**get-saved-search**](#get-saved-search) | **GET** `/saved-searches/{id}` | Return saved search by ID +[**list-saved-searches**](#list-saved-searches) | **GET** `/saved-searches` | A list of Saved Searches +[**put-saved-search**](#put-saved-search) | **PUT** `/saved-searches/{id}` | Updates an existing saved search + + +## create-saved-search +Create a saved search +Creates a new saved search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-saved-search) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | create_saved_search_request | [**CreateSavedSearchRequest**](../models/create-saved-search-request) | True | The saved search to persist. + +### Return type +[**SavedSearch**](../models/saved-search) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | The persisted saved search. | SavedSearch | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.saved_search_api import SavedSearchApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.create_saved_search_request import CreateSavedSearchRequest +from sailpoint.v2024.models.saved_search import SavedSearch +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + create_saved_search_request = '''sailpoint.v2024.CreateSavedSearchRequest()''' # CreateSavedSearchRequest | The saved search to persist. + + try: + # Create a saved search + new_create_saved_search_request = CreateSavedSearchRequest.from_json(create_saved_search_request) + results = SavedSearchApi(api_client).create_saved_search(create_saved_search_request=new_create_saved_search_request) + # Below is a request that includes all optional parameters + # results = SavedSearchApi(api_client).create_saved_search(new_create_saved_search_request) + print("The response of SavedSearchApi->create_saved_search:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SavedSearchApi->create_saved_search: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-saved-search +Delete document by ID +Deletes the specified saved search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-saved-search) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the requested document. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +204 | No Content - Indicates the request was successful but there is no content to be returned in the response. | | - | +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 + +```python +from sailpoint.v2024.api.saved_search_api import SavedSearchApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + + try: + # Delete document by ID + + SavedSearchApi(api_client).delete_saved_search(id=id) + # Below is a request that includes all optional parameters + # SavedSearchApi(api_client).delete_saved_search(id) + except Exception as e: + print("Exception when calling SavedSearchApi->delete_saved_search: %s\n" % e) +``` + + + +[[Back to top]](#) + +## execute-saved-search +Execute a saved search by ID +Executes the specified saved search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/execute-saved-search) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the requested document. + Body | search_arguments | [**SearchArguments**](../models/search-arguments) | True | When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Accepted - Returned if the request was successfully accepted into the system. | | - | +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.saved_search_api import SavedSearchApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.search_arguments import SearchArguments +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + search_arguments = '''{ + "owner" : "", + "recipients" : [ { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" + }''' # SearchArguments | When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. + + try: + # Execute a saved search by ID + new_search_arguments = SearchArguments.from_json(search_arguments) + SavedSearchApi(api_client).execute_saved_search(id=id, search_arguments=new_search_arguments) + # Below is a request that includes all optional parameters + # SavedSearchApi(api_client).execute_saved_search(id, new_search_arguments) + except Exception as e: + print("Exception when calling SavedSearchApi->execute_saved_search: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-saved-search +Return saved search by ID +Returns the specified saved search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-saved-search) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the requested document. + +### Return type +[**SavedSearch**](../models/saved-search) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The requested saved search. | SavedSearch | - | +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 + +```python +from sailpoint.v2024.api.saved_search_api import SavedSearchApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.saved_search import SavedSearch +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + + try: + # Return saved search by ID + + results = SavedSearchApi(api_client).get_saved_search(id=id) + # Below is a request that includes all optional parameters + # results = SavedSearchApi(api_client).get_saved_search(id) + print("The response of SavedSearchApi->get_saved_search:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SavedSearchApi->get_saved_search: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-saved-searches +A list of Saved Searches +Returns a list of saved searches. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-saved-searches) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | filters | **str** | (optional) | 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: **owner.id**: *eq* + +### Return type +[**List[SavedSearch]**](../models/saved-search) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The list of requested saved searches. | List[SavedSearch] | * X-Total-Count - The total result count. | +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 | - | +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 + +```python +from sailpoint.v2024.api.saved_search_api import SavedSearchApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.saved_search import SavedSearch +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + 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) + 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) + 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) + filters = 'owner.id eq \"7a724640-0c17-4ce9-a8c3-4a89738459c8\"' # 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: **owner.id**: *eq* (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: **owner.id**: *eq* (optional) + + try: + # A list of Saved Searches + + results = SavedSearchApi(api_client).list_saved_searches() + # Below is a request that includes all optional parameters + # results = SavedSearchApi(api_client).list_saved_searches(offset, limit, count, filters) + print("The response of SavedSearchApi->list_saved_searches:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SavedSearchApi->list_saved_searches: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-saved-search +Updates an existing saved search +Updates an existing saved search. + +>**NOTE: You cannot update the `owner` of the saved search.** + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-saved-search) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the requested document. + Body | saved_search | [**SavedSearch**](../models/saved-search) | True | The saved search to persist. + +### Return type +[**SavedSearch**](../models/saved-search) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The persisted saved search. | SavedSearch | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.saved_search_api import SavedSearchApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.saved_search import SavedSearch +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + saved_search = '''{ + "owner" : { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2018-06-25T20:22:28.104Z", + "columns" : { + "identity" : [ { + "field" : "displayName", + "header" : "Display Name" + }, { + "field" : "e-mail", + "header" : "Work Email" + } ] + }, + "query" : "@accounts(disabled:true)", + "description" : "Disabled accounts", + "orderBy" : { + "identity" : [ "lastName", "firstName" ], + "role" : [ "name" ] + }, + "sort" : [ "displayName" ], + "filters" : { + "terms" : [ "account_count", "account_count" ], + "range" : { + "lower" : { + "inclusive" : false, + "value" : "1" + }, + "upper" : { + "inclusive" : false, + "value" : "1" + } + }, + "exclude" : false, + "type" : "RANGE" + }, + "ownerId" : "2c91808568c529c60168cca6f90c1313", + "indices" : [ "identities" ], + "public" : false, + "name" : "Disabled accounts", + "modified" : "2018-06-25T20:22:28.104Z", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "fields" : [ "disabled" ] + }''' # SavedSearch | The saved search to persist. + + try: + # Updates an existing saved search + new_saved_search = SavedSearch.from_json(saved_search) + results = SavedSearchApi(api_client).put_saved_search(id=id, saved_search=new_saved_search) + # Below is a request that includes all optional parameters + # results = SavedSearchApi(api_client).put_saved_search(id, new_saved_search) + print("The response of SavedSearchApi->put_saved_search:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SavedSearchApi->put_saved_search: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ScheduledSearchApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ScheduledSearchApi.md new file mode 100644 index 000000000..78a5f785a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ScheduledSearchApi.md @@ -0,0 +1,508 @@ +--- +id: v2024-scheduled-search +title: Scheduled_Search +pagination_label: Scheduled_Search +sidebar_label: Scheduled_Search +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Scheduled_Search', 'V2024Scheduled_Search'] +slug: /tools/sdk/python/v2024/methods/scheduled-search +tags: ['SDK', 'Software Development Kit', 'Scheduled_Search', 'V2024Scheduled_Search'] +--- + +# sailpoint.v2024.ScheduledSearchApi + Use this API to implement scheduled search functionality. +With scheduled search functionality in place, users can run saved search queries on their tenants on a schedule, and Identity Security Cloud emails them the search results. +Users can also share these search results with other users by email by adding those users as subscribers, or those users can subscribe themselves. + +One of the greatest benefits of saving searches is the ability to run those searches on a schedule. +This is essential for organizations to constantly detect any changes to user information or access throughout their tenants and across all their sources. +For example, the manager Amanda Ross can schedule a saved search "manager.name:amanda.ross AND attributes.location:austin" on a schedule to regularly stay aware of changes with the Austin employees reporting to her. +Identity Security Cloud emails her the search results when the search runs, so she can work on other tasks instead of actively running this search. + +In Identity Security Cloud, scheduling a search involves a subscription. +Users can create a subscription for a saved search and schedule it to run daily, weekly, or monthly (you can only use one schedule option at a time). +The user can add other identities as subscribers so when the scheduled search runs, the subscribers and the user all receive emails. + +By default, subscriptions exclude detailed results from the emails, for security purposes. +Including detailed results about user access in an email may expose sensitive information. +However, the subscription creator can choose to include the information in the emails. + +By default, Identity Security Cloud sends emails to the subscribers even when the searches do not return new results. +However, the subscription creator can choose to suppress these empty emails. + +Users can also subscribe to saved searches that already have existing subscriptions so they receive emails when the searches run. +A saved search can have up to 10 subscriptions configured at a time. + +The subscription creator can enable, disable, or delete the subscription. + +Refer to [Subscribing to Saved Searches](https://documentation.sailpoint.com/saas/help/search/saved-searches.html#subscribing-to-saved-searches) for more information about scheduling searches and subscribing to them. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-scheduled-search**](#create-scheduled-search) | **POST** `/scheduled-searches` | Create a new scheduled search +[**delete-scheduled-search**](#delete-scheduled-search) | **DELETE** `/scheduled-searches/{id}` | Delete a Scheduled Search +[**get-scheduled-search**](#get-scheduled-search) | **GET** `/scheduled-searches/{id}` | Get a Scheduled Search +[**list-scheduled-search**](#list-scheduled-search) | **GET** `/scheduled-searches` | List scheduled searches +[**unsubscribe-scheduled-search**](#unsubscribe-scheduled-search) | **POST** `/scheduled-searches/{id}/unsubscribe` | Unsubscribe a recipient from Scheduled Search +[**update-scheduled-search**](#update-scheduled-search) | **PUT** `/scheduled-searches/{id}` | Update an existing Scheduled Search + + +## create-scheduled-search +Create a new scheduled search +Creates a new scheduled search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-scheduled-search) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | create_scheduled_search_request | [**CreateScheduledSearchRequest**](../models/create-scheduled-search-request) | True | The scheduled search to persist. + +### Return type +[**ScheduledSearch**](../models/scheduled-search) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | The persisted scheduled search. | ScheduledSearch | - | +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 + +```python +from sailpoint.v2024.api.scheduled_search_api import ScheduledSearchApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.create_scheduled_search_request import CreateScheduledSearchRequest +from sailpoint.v2024.models.scheduled_search import ScheduledSearch +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + create_scheduled_search_request = '''{savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]}''' # CreateScheduledSearchRequest | The scheduled search to persist. + + try: + # Create a new scheduled search + new_create_scheduled_search_request = CreateScheduledSearchRequest.from_json(create_scheduled_search_request) + results = ScheduledSearchApi(api_client).create_scheduled_search(create_scheduled_search_request=new_create_scheduled_search_request) + # Below is a request that includes all optional parameters + # results = ScheduledSearchApi(api_client).create_scheduled_search(new_create_scheduled_search_request) + print("The response of ScheduledSearchApi->create_scheduled_search:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ScheduledSearchApi->create_scheduled_search: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-scheduled-search +Delete a Scheduled Search +Deletes the specified scheduled search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-scheduled-search) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the requested document. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +204 | No Content - Indicates the request was successful but there is no content to be returned in the response. | | - | +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 + +```python +from sailpoint.v2024.api.scheduled_search_api import ScheduledSearchApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + + try: + # Delete a Scheduled Search + + ScheduledSearchApi(api_client).delete_scheduled_search(id=id) + # Below is a request that includes all optional parameters + # ScheduledSearchApi(api_client).delete_scheduled_search(id) + except Exception as e: + print("Exception when calling ScheduledSearchApi->delete_scheduled_search: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-scheduled-search +Get a Scheduled Search +Returns the specified scheduled search. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-scheduled-search) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the requested document. + +### Return type +[**ScheduledSearch**](../models/scheduled-search) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The requested scheduled search. | ScheduledSearch | - | +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 + +```python +from sailpoint.v2024.api.scheduled_search_api import ScheduledSearchApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.scheduled_search import ScheduledSearch +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + + try: + # Get a Scheduled Search + + results = ScheduledSearchApi(api_client).get_scheduled_search(id=id) + # Below is a request that includes all optional parameters + # results = ScheduledSearchApi(api_client).get_scheduled_search(id) + print("The response of ScheduledSearchApi->get_scheduled_search:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ScheduledSearchApi->get_scheduled_search: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-scheduled-search +List scheduled searches +Returns a list of scheduled searches. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-scheduled-search) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | filters | **str** | (optional) | 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: **owner.id**: *eq* **savedSearchId**: *eq* + +### Return type +[**List[ScheduledSearch]**](../models/scheduled-search) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The list of requested scheduled searches. | List[ScheduledSearch] | * X-Total-Count - The total result count. | +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 + +```python +from sailpoint.v2024.api.scheduled_search_api import ScheduledSearchApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.scheduled_search import ScheduledSearch +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + 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) + 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) + 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) + filters = 'savedSearchId eq \"6cc0945d-9eeb-4948-9033-72d066e1153e\"' # 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: **owner.id**: *eq* **savedSearchId**: *eq* (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: **owner.id**: *eq* **savedSearchId**: *eq* (optional) + + try: + # List scheduled searches + + results = ScheduledSearchApi(api_client).list_scheduled_search() + # Below is a request that includes all optional parameters + # results = ScheduledSearchApi(api_client).list_scheduled_search(offset, limit, count, filters) + print("The response of ScheduledSearchApi->list_scheduled_search:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ScheduledSearchApi->list_scheduled_search: %s\n" % e) +``` + + + +[[Back to top]](#) + +## unsubscribe-scheduled-search +Unsubscribe a recipient from Scheduled Search +Unsubscribes a recipient from the specified scheduled search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/unsubscribe-scheduled-search) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the requested document. + Body | typed_reference | [**TypedReference**](../models/typed-reference) | True | The recipient to be removed from the scheduled search. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +204 | No Content - Indicates the request was successful but there is no content to be returned in the response. | | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +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 | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2024.api.scheduled_search_api import ScheduledSearchApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.typed_reference import TypedReference +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + typed_reference = '''{ + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }''' # TypedReference | The recipient to be removed from the scheduled search. + + try: + # Unsubscribe a recipient from Scheduled Search + new_typed_reference = TypedReference.from_json(typed_reference) + ScheduledSearchApi(api_client).unsubscribe_scheduled_search(id=id, typed_reference=new_typed_reference) + # Below is a request that includes all optional parameters + # ScheduledSearchApi(api_client).unsubscribe_scheduled_search(id, new_typed_reference) + except Exception as e: + print("Exception when calling ScheduledSearchApi->unsubscribe_scheduled_search: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-scheduled-search +Update an existing Scheduled Search +Updates an existing scheduled search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-scheduled-search) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the requested document. + Body | scheduled_search | [**ScheduledSearch**](../models/scheduled-search) | True | The scheduled search to persist. + +### Return type +[**ScheduledSearch**](../models/scheduled-search) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The persisted scheduled search. | ScheduledSearch | - | +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 + +```python +from sailpoint.v2024.api.scheduled_search_api import ScheduledSearchApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.scheduled_search import ScheduledSearch +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + scheduled_search = '''{ + "owner" : { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "displayQueryDetails" : false, + "created" : "", + "description" : "Daily disabled accounts", + "ownerId" : "2c9180867624cbd7017642d8c8c81f67", + "enabled" : false, + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "recipients" : [ { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + } ], + "savedSearchId" : "554f1511-f0a1-4744-ab14-599514d3e57c", + "name" : "Daily disabled accounts", + "modified" : "", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "emailEmptyResults" : false + }''' # ScheduledSearch | The scheduled search to persist. + + try: + # Update an existing Scheduled Search + new_scheduled_search = ScheduledSearch.from_json(scheduled_search) + results = ScheduledSearchApi(api_client).update_scheduled_search(id=id, scheduled_search=new_scheduled_search) + # Below is a request that includes all optional parameters + # results = ScheduledSearchApi(api_client).update_scheduled_search(id, new_scheduled_search) + print("The response of ScheduledSearchApi->update_scheduled_search:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ScheduledSearchApi->update_scheduled_search: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SearchApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SearchApi.md new file mode 100644 index 000000000..af9ea61ee --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SearchApi.md @@ -0,0 +1,641 @@ +--- +id: v2024-search +title: Search +pagination_label: Search +sidebar_label: Search +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Search', 'V2024Search'] +slug: /tools/sdk/python/v2024/methods/search +tags: ['SDK', 'Software Development Kit', 'Search', 'V2024Search'] +--- + +# sailpoint.v2024.SearchApi + Use this API to implement search functionality. +With search functionality in place, users can search their tenants for nearly any information from throughout their organizations. + +Identity Security Cloud enables organizations to store user data from across all their connected sources and manage the users' access, so the ability to query and filter that data is essential. +Its search goes through all those sources and finds the results quickly and specifically. + +The search query is flexible - it can be very broad or very narrow. +The search only returns results for searchable objects it is filtering for. +The following objects are searchable: identities, roles, access profiles, entitlements, events, and account activities. +By default, no filter is applied, so a search for "Ad" returns both the identity "Adam.Archer" as well as the role "Administrator." + +Users can further narrow their results by using Identity Security Cloud's specific syntax and punctuation to structure their queries. +For example, the query "attributes.location:austin AND NOT manager.name:amanda.ross" returns all results associated with the Austin location, but it excludes those associated with the manager Amanda Ross. +Refer to [Building a Search Query](https://documentation.sailpoint.com/saas/help/search/building-query.html) for more information about how to construct specific search queries. + +Refer to [Using Search](https://documentation.sailpoint.com/saas/help/search/index.html) for more information about Identity Security Cloud's search and its different possibilities. + +The search feature uses Elasticsearch as a datastore and query engine. +The power of Elasticsearch makes this feature suitable for ad-hoc reporting. +However, data from the operational databases (ex. identities, roles, events, etc) has to be ingested into Elasticsearch. +This ingestion process introduces a latency from when the operational data is created to when it is available in search. +Depending on the system load, this can take a few seconds to a few minutes. +Please keep this latency in mind when you use search. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**search-aggregate**](#search-aggregate) | **POST** `/search/aggregate` | Perform a Search Query Aggregation +[**search-count**](#search-count) | **POST** `/search/count` | Count Documents Satisfying a Query +[**search-get**](#search-get) | **GET** `/search/{index}/{id}` | Get a Document by ID +[**search-post**](#search-post) | **POST** `/search` | Perform Search + + +## search-aggregate +Perform a Search Query Aggregation +Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-aggregate) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | search | [**Search**](../models/search) | True | + 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**AggregationResult**](../models/aggregation-result) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Aggregation results. | AggregationResult | * X-Total-Count - The total result count. | +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 | - | +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, text/csv + +### Example + +```python +from sailpoint.v2024.api.search_api import SearchApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.aggregation_result import AggregationResult +from sailpoint.v2024.models.search import Search +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + search = '''{ + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + }''' # Search | + 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) + 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) + 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: + # Perform a Search Query Aggregation + new_search = Search.from_json(search) + results = SearchApi(api_client).search_aggregate(search=new_search) + # Below is a request that includes all optional parameters + # results = SearchApi(api_client).search_aggregate(new_search, offset, limit, count) + print("The response of SearchApi->search_aggregate:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchApi->search_aggregate: %s\n" % e) +``` + + + +[[Back to top]](#) + +## search-count +Count Documents Satisfying a Query +Performs a search with a provided query and returns the count of results in the X-Total-Count header. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-count) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | search | [**Search**](../models/search) | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +204 | No content - indicates the request was successful but there is no content to be returned in the response. | | * X-Total-Count - The total result count. | +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 | - | +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 + +```python +from sailpoint.v2024.api.search_api import SearchApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.search import Search +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + search = '''{ + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + }''' # Search | + + try: + # Count Documents Satisfying a Query + new_search = Search.from_json(search) + SearchApi(api_client).search_count(search=new_search) + # Below is a request that includes all optional parameters + # SearchApi(api_client).search_count(new_search) + except Exception as e: + print("Exception when calling SearchApi->search_count: %s\n" % e) +``` + + + +[[Back to top]](#) + +## search-get +Get a Document by ID +Fetches a single document from the specified index, using the specified document ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-get) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | index | **str** | True | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. +Path | id | **str** | True | ID of the requested document. + +### Return type +**object** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The requested document. | object | - | +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 + +```python +from sailpoint.v2024.api.search_api import SearchApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + index = 'identities' # str | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. # str | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + + try: + # Get a Document by ID + + results = SearchApi(api_client).search_get(index=index, id=id) + # Below is a request that includes all optional parameters + # results = SearchApi(api_client).search_get(index, id) + print("The response of SearchApi->search_get:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchApi->search_get: %s\n" % e) +``` + + + +[[Back to top]](#) + +## search-post +Perform Search +Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-post) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | search | [**Search**](../models/search) | True | + 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +**List[object]** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of matching documents. | List[object] | * X-Total-Count - The total result count. | +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 | - | +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 + +```python +from sailpoint.v2024.api.search_api import SearchApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.search import Search +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + search = '''{ + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + }''' # Search | + 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) + 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) + 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: + # Perform Search + new_search = Search.from_json(search) + results = SearchApi(api_client).search_post(search=new_search) + # Below is a request that includes all optional parameters + # results = SearchApi(api_client).search_post(new_search, offset, limit, count) + print("The response of SearchApi->search_post:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchApi->search_post: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SearchAttributeConfigurationApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SearchAttributeConfigurationApi.md new file mode 100644 index 000000000..7aad9521b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SearchAttributeConfigurationApi.md @@ -0,0 +1,419 @@ +--- +id: v2024-search-attribute-configuration +title: Search_Attribute_Configuration +pagination_label: Search_Attribute_Configuration +sidebar_label: Search_Attribute_Configuration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Search_Attribute_Configuration', 'V2024Search_Attribute_Configuration'] +slug: /tools/sdk/python/v2024/methods/search-attribute-configuration +tags: ['SDK', 'Software Development Kit', 'Search_Attribute_Configuration', 'V2024Search_Attribute_Configuration'] +--- + +# sailpoint.v2024.SearchAttributeConfigurationApi + Use this API to implement search attribute configuration functionality, along with [Search](https://developer.sailpoint.com/docs/api/v2024/search). +With this functionality in place, administrators can create custom search attributes that and run extended searches based on those attributes to further narrow down their searches and get the information and insights they want. + +Identity Security Cloud (ISC) enables organizations to store user data from across all their connected sources and manage the users' access, so the ability to query and filter that data is essential. +Its search goes through all those sources and finds the results quickly and specifically. + +The search query is flexible - it can be very broad or very narrow. +The search only returns results for searchable objects it is filtering for. +The following objects are searchable: identities, roles, access profiles, entitlements, events, and account activities. +By default, no filter is applied, so a search for "Ad" returns both the identity "Adam.Archer" as well as the role "Administrator." + +Users can further narrow their results by using ISC's specific syntax and punctuation to structure their queries. +For example, the query "attributes.location:austin AND NOT manager.name:amanda.ross" returns all results associated with the Austin location, but it excludes those associated with the manager Amanda Ross. +Refer to [Building a Search Query](https://documentation.sailpoint.com/saas/help/search/building-query.html) for more information about how to construct specific search queries. + +Refer to [Using Search](https://documentation.sailpoint.com/saas/help/search/index.html) for more information about ISC's search and its different possibilities. + +With Search Attribute Configuration, administrators can create, manage, and run searches based on the attributes they want to search. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-search-attribute-config**](#create-search-attribute-config) | **POST** `/accounts/search-attribute-config` | Create Extended Search Attributes +[**delete-search-attribute-config**](#delete-search-attribute-config) | **DELETE** `/accounts/search-attribute-config/{name}` | Delete Extended Search Attribute +[**get-search-attribute-config**](#get-search-attribute-config) | **GET** `/accounts/search-attribute-config` | List Extended Search Attributes +[**get-single-search-attribute-config**](#get-single-search-attribute-config) | **GET** `/accounts/search-attribute-config/{name}` | Get Extended Search Attribute +[**patch-search-attribute-config**](#patch-search-attribute-config) | **PATCH** `/accounts/search-attribute-config/{name}` | Update Extended Search Attribute + + +## create-search-attribute-config +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +Create Extended Search Attributes +Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. +>**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes' `applicationAttributes`.** + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-search-attribute-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Body | search_attribute_config | [**SearchAttributeConfig**](../models/search-attribute-config) | True | + +### Return type +**object** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Accepted - Returned if the request was successfully accepted into the system. | object | - | +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 + +```python +from sailpoint.v2024.api.search_attribute_configuration_api import SearchAttributeConfigurationApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.search_attribute_config import SearchAttributeConfig +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + search_attribute_config = '''{ + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + }''' # SearchAttributeConfig | + + try: + # Create Extended Search Attributes + new_search_attribute_config = SearchAttributeConfig.from_json(search_attribute_config) + results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(x_sail_point_experimental=x_sail_point_experimental, search_attribute_config=new_search_attribute_config) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(x_sail_point_experimental, new_search_attribute_config) + print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->create_search_attribute_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-search-attribute-config +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +Delete Extended Search Attribute +Delete an extended attribute configuration by name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-search-attribute-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | name | **str** | True | Name of the extended search attribute configuration to delete. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +204 | No content - indicates the request was successful but there is no content to be returned in the response. | | - | +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 + +```python +from sailpoint.v2024.api.search_attribute_configuration_api import SearchAttributeConfigurationApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + name = 'newMailAttribute' # str | Name of the extended search attribute configuration to delete. # str | Name of the extended search attribute configuration to delete. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + + try: + # Delete Extended Search Attribute + + SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name=name, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name, x_sail_point_experimental) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->delete_search_attribute_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-search-attribute-config +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +List Extended Search Attributes +Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-search-attribute-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**List[SearchAttributeConfig]**](../models/search-attribute-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of attribute configurations in ISC. | List[SearchAttributeConfig] | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.search_attribute_configuration_api import SearchAttributeConfigurationApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.search_attribute_config import SearchAttributeConfig +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + + try: + # List Extended Search Attributes + + results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(x_sail_point_experimental, limit, offset) + print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-single-search-attribute-config +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +Get Extended Search Attribute +Get an extended attribute configuration by name. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-single-search-attribute-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | name | **str** | True | Name of the extended search attribute configuration to get. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + +### Return type +[**SearchAttributeConfig**](../models/search-attribute-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Specific attribute configuration in IdentityNow. | SearchAttributeConfig | - | +204 | No content - indicates the request was successful but there is no content to be returned in the response. | | - | +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 + +```python +from sailpoint.v2024.api.search_attribute_configuration_api import SearchAttributeConfigurationApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.search_attribute_config import SearchAttributeConfig +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + name = 'newMailAttribute' # str | Name of the extended search attribute configuration to get. # str | Name of the extended search attribute configuration to get. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + + try: + # Get Extended Search Attribute + + results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name=name, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name, x_sail_point_experimental) + print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-search-attribute-config +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +Update Extended Search Attribute +Update an existing search attribute configuration. +You can patch these fields: +* name * displayName * applicationAttributes + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-search-attribute-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | name | **str** | True | Name of the search attribute configuration to patch. + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | + +### Return type +[**SearchAttributeConfig**](../models/search-attribute-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with the search attribute configuration as updated. | SearchAttributeConfig | - | +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-patch+json + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2024.api.search_attribute_configuration_api import SearchAttributeConfigurationApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation +from sailpoint.v2024.models.search_attribute_config import SearchAttributeConfig +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = true + +with ApiClient(configuration) as api_client: + name = 'promotedMailAttribute' # str | Name of the search attribute configuration to patch. # str | Name of the search attribute configuration to patch. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch_operation = '''[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}]''' # List[JsonPatchOperation] | + + try: + # Update Extended Search Attribute + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name=name, x_sail_point_experimental=x_sail_point_experimental, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name, x_sail_point_experimental, new_json_patch_operation) + print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->patch_search_attribute_config: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SegmentsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SegmentsApi.md new file mode 100644 index 000000000..7a491b87f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SegmentsApi.md @@ -0,0 +1,365 @@ +--- +id: v2024-segments +title: Segments +pagination_label: Segments +sidebar_label: Segments +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Segments', 'V2024Segments'] +slug: /tools/sdk/python/v2024/methods/segments +tags: ['SDK', 'Software Development Kit', 'Segments', 'V2024Segments'] +--- + +# sailpoint.v2024.SegmentsApi + Use this API to implement and customize access request segment functionality. +With this functionality in place, administrators can create and manage access request segments. +Segments provide organizations with a way to make the access their users have even more granular - this can simply the access request process for the organization's users and improves security by reducing the risk of overprovisoning access. + +Segments represent sets of identities, all grouped by specified identity attributes, who are only able to see and access the access items associated with their segments. +For example, administrators could group all their organization's London office employees into one segment, "London Office Employees," by their shared location. +The administrators could then define the access items the London employees would need, and the identities in the "London Office Employees" would then only be able to see and access those items. + +In Identity Security Cloud, administrators can use the 'Access' drop-down menu and select 'Segments' to reach the 'Access Requests Segments' page. +This page lists all the existing access request segments, along with their statuses, enabled or disabled. +Administrators can use this page to create, edit, enable, disable, and delete segments. +To create a segment, an administrator must provide a name, define the identities grouped in the segment, and define the items the identities in the segment can access. +These items can be access profiles, roles, or entitlements. + +When administrators use the API to create and manage segments, they use a JSON expression in the `visibilityCriteria` object to define the segment's identities and access items. + +Refer to [Managing Access Request Segments](https://documentation.sailpoint.com/saas/help/requests/segments.html) for more information about segments in Identity Security Cloud. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-segment**](#create-segment) | **POST** `/segments` | Create Segment +[**delete-segment**](#delete-segment) | **DELETE** `/segments/{id}` | Delete Segment by ID +[**get-segment**](#get-segment) | **GET** `/segments/{id}` | Get Segment by ID +[**list-segments**](#list-segments) | **GET** `/segments` | List Segments +[**patch-segment**](#patch-segment) | **PATCH** `/segments/{id}` | Update Segment + + +## create-segment +Create Segment +This API creates a segment. +>**Note:** Segment definitions may take time to propagate to all identities. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-segment) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | segment | [**Segment**](../models/segment) | True | + +### Return type +[**Segment**](../models/segment) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Segment created | Segment | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.segments_api import SegmentsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.segment import Segment +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + segment = '''{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" + } + }, + "name" : "segment-xyz", + "modified" : "2020-01-01T00:00:00Z", + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" + }''' # Segment | + + try: + # Create Segment + new_segment = Segment.from_json(segment) + results = SegmentsApi(api_client).create_segment(segment=new_segment) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).create_segment(new_segment) + print("The response of SegmentsApi->create_segment:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SegmentsApi->create_segment: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-segment +Delete Segment by ID +This API deletes the segment specified by the given ID. +>**Note:** that segment deletion may take some time to become effective. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-segment) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The segment ID 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. | 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 + +```python +from sailpoint.v2024.api.segments_api import SegmentsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. + + try: + # Delete Segment by ID + + SegmentsApi(api_client).delete_segment(id=id) + # Below is a request that includes all optional parameters + # SegmentsApi(api_client).delete_segment(id) + except Exception as e: + print("Exception when calling SegmentsApi->delete_segment: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-segment +Get Segment by ID +This API returns the segment specified by the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-segment) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The segment ID to retrieve. + +### Return type +[**Segment**](../models/segment) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Segment | Segment | - | +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 + +```python +from sailpoint.v2024.api.segments_api import SegmentsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.segment import Segment +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. + + try: + # Get Segment by ID + + results = SegmentsApi(api_client).get_segment(id=id) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).get_segment(id) + print("The response of SegmentsApi->get_segment:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SegmentsApi->get_segment: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-segments +List Segments +This API returns a list of all segments. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-segments) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + 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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**List[Segment]**](../models/segment) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of all segments | List[Segment] | - | +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 | - | +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 + +```python +from sailpoint.v2024.api.segments_api import SegmentsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.segment import Segment +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + 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 Segments + + results = SegmentsApi(api_client).list_segments() + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).list_segments(limit, offset, count) + print("The response of SegmentsApi->list_segments:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SegmentsApi->list_segments: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-segment +Update Segment +Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +>**Note:** Changes to a segment may take some time to propagate to all identities. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-segment) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The segment ID to modify. + Body | request_body | **[]object** | True | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + +### Return type +[**Segment**](../models/segment) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Indicates the PATCH operation succeeded, and returns the segment's new representation. | Segment | - | +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-patch+json + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2024.api.segments_api import SegmentsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.segment import Segment +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to modify. # str | The segment ID to modify. + request_body = '''[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]''' # List[object] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + + try: + # Update Segment + new_request_body = RequestBody.from_json(request_body) + results = SegmentsApi(api_client).patch_segment(id=id, request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).patch_segment(id, new_request_body) + print("The response of SegmentsApi->patch_segment:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SegmentsApi->patch_segment: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ServiceDeskIntegrationApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ServiceDeskIntegrationApi.md new file mode 100644 index 000000000..5f46f7d43 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ServiceDeskIntegrationApi.md @@ -0,0 +1,716 @@ +--- +id: v2024-service-desk-integration +title: Service_Desk_Integration +pagination_label: Service_Desk_Integration +sidebar_label: Service_Desk_Integration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Service_Desk_Integration', 'V2024Service_Desk_Integration'] +slug: /tools/sdk/python/v2024/methods/service-desk-integration +tags: ['SDK', 'Software Development Kit', 'Service_Desk_Integration', 'V2024Service_Desk_Integration'] +--- + +# sailpoint.v2024.ServiceDeskIntegrationApi + Use this API to build an integration between Identity Security Cloud and a service desk ITSM (IT service management) solution. +Once an administrator builds this integration between Identity Security Cloud and a service desk, users can use Identity Security Cloud to raise and track tickets that are synchronized between Identity Security Cloud and the service desk. + +In Identity Security Cloud, administrators can create a service desk integration (sometimes also called an SDIM, or Service Desk Integration Module) by going to Admin > Connections > Service Desk and selecting 'Create.' + +To create a Generic Service Desk integration, for example, administrators must provide the required information on the General Settings page, the Connectivity and Authentication information, Ticket Creation information, Status Mapping information, and Requester Source information on the Configure page. +Refer to [Integrating SailPoint with Generic Service Desk](https://documentation.sailpoint.com/connectors/generic_sd/help/integrating_generic_service_desk/intro.html) for more information about the process of setting up a Generic Service Desk in Identity Security Cloud. + +Administrators can create various service desk integrations, all with their own nuances. +The following service desk integrations are available: + +- [Atlassian Cloud Jira Service Management](https://documentation.sailpoint.com/connectors/atlassian/jira_cloud/help/integrating_jira_cloud_sd/introduction.html) + +- [Atlassian Server Jira Service Management](https://documentation.sailpoint.com/connectors/atlassian/jira_server/help/integrating_jira_server_sd/introduction.html) + +- [BMC Helix ITSM Service Desk](https://documentation.sailpoint.com/connectors/bmc/helix_ITSM_sd/help/integrating_bmc_helix_itsm_sd/intro.html) + +- [BMC Helix Remedyforce Service Desk](https://documentation.sailpoint.com/connectors/bmc/helix_remedyforce_sd/help/integrating_bmc_helix_remedyforce_sd/intro.html) + +- [Generic Service Desk](https://documentation.sailpoint.com/connectors/generic_sd/help/integrating_generic_service_desk/intro.html) + +- [ServiceNow Service Desk](https://documentation.sailpoint.com/connectors/servicenow/sdim/help/integrating_servicenow_sdim/intro.html) + +- [Zendesk Service Desk](https://documentation.sailpoint.com/connectors/zendesk/help/integrating_zendesk_sd/introduction.html) + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-service-desk-integration**](#create-service-desk-integration) | **POST** `/service-desk-integrations` | Create new Service Desk integration +[**delete-service-desk-integration**](#delete-service-desk-integration) | **DELETE** `/service-desk-integrations/{id}` | Delete a Service Desk integration +[**get-service-desk-integration**](#get-service-desk-integration) | **GET** `/service-desk-integrations/{id}` | Get a Service Desk integration +[**get-service-desk-integration-template**](#get-service-desk-integration-template) | **GET** `/service-desk-integrations/templates/{scriptName}` | Service Desk integration template by scriptName +[**get-service-desk-integration-types**](#get-service-desk-integration-types) | **GET** `/service-desk-integrations/types` | List Service Desk integration types +[**get-service-desk-integrations**](#get-service-desk-integrations) | **GET** `/service-desk-integrations` | List existing Service Desk integrations +[**get-status-check-details**](#get-status-check-details) | **GET** `/service-desk-integrations/status-check-configuration` | Get the time check configuration +[**patch-service-desk-integration**](#patch-service-desk-integration) | **PATCH** `/service-desk-integrations/{id}` | Patch a Service Desk Integration +[**put-service-desk-integration**](#put-service-desk-integration) | **PUT** `/service-desk-integrations/{id}` | Update a Service Desk integration +[**update-status-check-details**](#update-status-check-details) | **PUT** `/service-desk-integrations/status-check-configuration` | Update the time check configuration + + +## create-service-desk-integration +Create new Service Desk integration +Create a new Service Desk integration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-service-desk-integration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | service_desk_integration_dto | [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) | True | The specifics of a new integration to create + +### Return type +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Details of the created integration | ServiceDeskIntegrationDto | - | +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 + +```python +from sailpoint.v2024.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + service_desk_integration_dto = '''{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n
Geben Sie bei Zeit\u00fcberschreitung bei Verbindung die maximal erlaubte Zeitdauer (in Minuten) f\u00fcr die Verbindung von IdentityNow mit der Quelle ein.
Geben Sie die Host-URL der Delinea-SCIM-Serverquelle ein.
Geben Sie den API-Token der Quelle zur Authentifizierung ein. +sectionInfo_AggregationSettings=Geben Sie die Einstellungen f\u00fcr Ihre Aggregation an.
Geben Sie in das Feld Seitengr\u00f6\u00dfe die Anzahl an Kontoeintr\u00e4gen ein, die auf einer einzelnen Seite aggregiert werden sollen, wenn gro\u00dfe Datens\u00e4tze durchlaufen werden.
\n
Geben Sie im Kontofilter die Bedingungen f\u00fcr den Kontofilter an. Beispiel: userName sw "S"
Geben Sie im Gruppenfilter die Gruppenfilterbedingungen an. Beispiel: displayName sw "S". +placeHolder_accAggregation=userName sw "S" +placeHolder_grpAggregation=displayName sw "S" +placeHolder_host=https://{Delinea_SCIM_Server_host}/v2 +docLinkLabel_AuthenticationSettings=Mehr \u00fcber Verbindungseinstellungen +docLinkLabel_Filters=Mehr \u00fcber Konto- und Gruppenfilter +HostURL=Host-URL +ConnectionTimeout=Zeit\u00fcberschreitung bei Verbindung +API_TOKEN=API-Token +JSONPathMapping=JSON-Path-Attribut-Mapping +FilterConditionForAccounts=Kontofilter +FilterConditionForGroups=Gruppenfilter +Page_Size=Seitengr\u00f6\u00dfe +SchemaAttribute=Schema-Attribut +JSONpath=JSON-Pfad +ShortDesc=Das Integrationsmodul IdentityNow f\u00fcr Delinea Secret Server On-Premise bietet die M\u00f6glichkeit einer tiefen Governance f\u00fcr Konten und Gruppen. Es unterst\u00fctzt au\u00dferdem das End-to-End-Lebenszyklus-Management.}, +connector_metadata={supportedUI=EXTJS, platform=ccg, shortDesc=connector description}, +status='RELEASED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ConnectorRuleCreateRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/ConnectorRuleCreateRequest.md new file mode 100644 index 000000000..207ad0cb5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ConnectorRuleCreateRequest.md @@ -0,0 +1,56 @@ +--- +id: v2024-connector-rule-create-request +title: ConnectorRuleCreateRequest +pagination_label: ConnectorRuleCreateRequest +sidebar_label: ConnectorRuleCreateRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConnectorRuleCreateRequest', 'V2024ConnectorRuleCreateRequest'] +slug: /tools/sdk/python/v2024/models/connector-rule-create-request +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleCreateRequest', 'V2024ConnectorRuleCreateRequest'] +--- + +# ConnectorRuleCreateRequest + +ConnectorRuleCreateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | the name of the rule | [required] +**description** | **str** | a description of the rule's purpose | [optional] +**type** | **Enum** [ 'BuildMap', 'ConnectorAfterCreate', 'ConnectorAfterDelete', 'ConnectorAfterModify', 'ConnectorBeforeCreate', 'ConnectorBeforeDelete', 'ConnectorBeforeModify', 'JDBCBuildMap', 'JDBCOperationProvisioning', 'JDBCProvision', 'PeopleSoftHRMSBuildMap', 'PeopleSoftHRMSOperationProvisioning', 'PeopleSoftHRMSProvision', 'RACFPermissionCustomization', 'ResourceObjectCustomization', 'SAPBuildMap', 'SapHrManagerRule', 'SapHrOperationProvisioning', 'SapHrProvision', 'SuccessFactorsOperationProvisioning', 'WebServiceAfterOperationRule', 'WebServiceBeforeOperationRule', 'ResourceObjectCustomization' ] | the type of rule | [required] +**signature** | [**ConnectorRuleCreateRequestSignature**](connector-rule-create-request-signature) | | [optional] +**source_code** | [**SourceCode**](source-code) | | [required] +**attributes** | **object** | a map of string to objects | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.connector_rule_create_request import ConnectorRuleCreateRequest + +connector_rule_create_request = ConnectorRuleCreateRequest( +name='WebServiceBeforeOperationRule', +description='This rule does that', +type='BuildMap', +signature=sailpoint.v2024.models.connector_rule_create_request_signature.ConnectorRuleCreateRequest_signature( + input = [ + sailpoint.v2024.models.argument.Argument( + name = 'firstName', + description = 'the first name of the identity', + type = 'String', ) + ], + output = sailpoint.v2024.models.argument.Argument( + name = 'firstName', + description = 'the first name of the identity', + type = 'String', ), ), +source_code=sailpoint.v2024.models.source_code.SourceCode( + version = '1.0', + script = 'return "Mr. " + firstName;', ), +attributes={} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ConnectorRuleCreateRequestSignature.md b/docs/tools/sdk/python/Reference/V2024/Models/ConnectorRuleCreateRequestSignature.md new file mode 100644 index 000000000..4df3dbe19 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ConnectorRuleCreateRequestSignature.md @@ -0,0 +1,44 @@ +--- +id: v2024-connector-rule-create-request-signature +title: ConnectorRuleCreateRequestSignature +pagination_label: ConnectorRuleCreateRequestSignature +sidebar_label: ConnectorRuleCreateRequestSignature +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConnectorRuleCreateRequestSignature', 'V2024ConnectorRuleCreateRequestSignature'] +slug: /tools/sdk/python/v2024/models/connector-rule-create-request-signature +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleCreateRequestSignature', 'V2024ConnectorRuleCreateRequestSignature'] +--- + +# ConnectorRuleCreateRequestSignature + +The rule's function signature. Describes the rule's input arguments and output (if any) + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**input** | [**[]Argument**](argument) | | [required] +**output** | [**Argument**](argument) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.connector_rule_create_request_signature import ConnectorRuleCreateRequestSignature + +connector_rule_create_request_signature = ConnectorRuleCreateRequestSignature( +input=[ + sailpoint.v2024.models.argument.Argument( + name = 'firstName', + description = 'the first name of the identity', + type = 'String', ) + ], +output=sailpoint.v2024.models.argument.Argument( + name = 'firstName', + description = 'the first name of the identity', + type = 'String', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ConnectorRuleResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/ConnectorRuleResponse.md new file mode 100644 index 000000000..89cab6a8f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ConnectorRuleResponse.md @@ -0,0 +1,62 @@ +--- +id: v2024-connector-rule-response +title: ConnectorRuleResponse +pagination_label: ConnectorRuleResponse +sidebar_label: ConnectorRuleResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConnectorRuleResponse', 'V2024ConnectorRuleResponse'] +slug: /tools/sdk/python/v2024/models/connector-rule-response +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleResponse', 'V2024ConnectorRuleResponse'] +--- + +# ConnectorRuleResponse + +ConnectorRuleResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | the name of the rule | [required] +**description** | **str** | a description of the rule's purpose | [optional] +**type** | **Enum** [ 'BuildMap', 'ConnectorAfterCreate', 'ConnectorAfterDelete', 'ConnectorAfterModify', 'ConnectorBeforeCreate', 'ConnectorBeforeDelete', 'ConnectorBeforeModify', 'JDBCBuildMap', 'JDBCOperationProvisioning', 'JDBCProvision', 'PeopleSoftHRMSBuildMap', 'PeopleSoftHRMSOperationProvisioning', 'PeopleSoftHRMSProvision', 'RACFPermissionCustomization', 'ResourceObjectCustomization', 'SAPBuildMap', 'SapHrManagerRule', 'SapHrOperationProvisioning', 'SapHrProvision', 'SuccessFactorsOperationProvisioning', 'WebServiceAfterOperationRule', 'WebServiceBeforeOperationRule', 'ResourceObjectCustomization' ] | the type of rule | [required] +**signature** | [**ConnectorRuleCreateRequestSignature**](connector-rule-create-request-signature) | | [optional] +**source_code** | [**SourceCode**](source-code) | | [required] +**attributes** | **object** | a map of string to objects | [optional] +**id** | **str** | the ID of the rule | [required] +**created** | **str** | an ISO 8601 UTC timestamp when this rule was created | [required] +**modified** | **str** | an ISO 8601 UTC timestamp when this rule was last modified | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.connector_rule_response import ConnectorRuleResponse + +connector_rule_response = ConnectorRuleResponse( +name='WebServiceBeforeOperationRule', +description='This rule does that', +type='BuildMap', +signature=sailpoint.v2024.models.connector_rule_create_request_signature.ConnectorRuleCreateRequest_signature( + input = [ + sailpoint.v2024.models.argument.Argument( + name = 'firstName', + description = 'the first name of the identity', + type = 'String', ) + ], + output = sailpoint.v2024.models.argument.Argument( + name = 'firstName', + description = 'the first name of the identity', + type = 'String', ), ), +source_code=sailpoint.v2024.models.source_code.SourceCode( + version = '1.0', + script = 'return "Mr. " + firstName;', ), +attributes={}, +id='8113d48c0b914f17b4c6072d4dcb9dfe', +created='021-07-22T15:59:23Z', +modified='021-07-22T15:59:23Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ConnectorRuleUpdateRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/ConnectorRuleUpdateRequest.md new file mode 100644 index 000000000..d8671b8b0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ConnectorRuleUpdateRequest.md @@ -0,0 +1,58 @@ +--- +id: v2024-connector-rule-update-request +title: ConnectorRuleUpdateRequest +pagination_label: ConnectorRuleUpdateRequest +sidebar_label: ConnectorRuleUpdateRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConnectorRuleUpdateRequest', 'V2024ConnectorRuleUpdateRequest'] +slug: /tools/sdk/python/v2024/models/connector-rule-update-request +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleUpdateRequest', 'V2024ConnectorRuleUpdateRequest'] +--- + +# ConnectorRuleUpdateRequest + +ConnectorRuleUpdateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | the name of the rule | [required] +**description** | **str** | a description of the rule's purpose | [optional] +**type** | **Enum** [ 'BuildMap', 'ConnectorAfterCreate', 'ConnectorAfterDelete', 'ConnectorAfterModify', 'ConnectorBeforeCreate', 'ConnectorBeforeDelete', 'ConnectorBeforeModify', 'JDBCBuildMap', 'JDBCOperationProvisioning', 'JDBCProvision', 'PeopleSoftHRMSBuildMap', 'PeopleSoftHRMSOperationProvisioning', 'PeopleSoftHRMSProvision', 'RACFPermissionCustomization', 'ResourceObjectCustomization', 'SAPBuildMap', 'SapHrManagerRule', 'SapHrOperationProvisioning', 'SapHrProvision', 'SuccessFactorsOperationProvisioning', 'WebServiceAfterOperationRule', 'WebServiceBeforeOperationRule', 'ResourceObjectCustomization' ] | the type of rule | [required] +**signature** | [**ConnectorRuleCreateRequestSignature**](connector-rule-create-request-signature) | | [optional] +**source_code** | [**SourceCode**](source-code) | | [required] +**attributes** | **object** | a map of string to objects | [optional] +**id** | **str** | the ID of the rule to update | [required] +} + +## Example + +```python +from sailpoint.v2024.models.connector_rule_update_request import ConnectorRuleUpdateRequest + +connector_rule_update_request = ConnectorRuleUpdateRequest( +name='WebServiceBeforeOperationRule', +description='This rule does that', +type='BuildMap', +signature=sailpoint.v2024.models.connector_rule_create_request_signature.ConnectorRuleCreateRequest_signature( + input = [ + sailpoint.v2024.models.argument.Argument( + name = 'firstName', + description = 'the first name of the identity', + type = 'String', ) + ], + output = sailpoint.v2024.models.argument.Argument( + name = 'firstName', + description = 'the first name of the identity', + type = 'String', ), ), +source_code=sailpoint.v2024.models.source_code.SourceCode( + version = '1.0', + script = 'return "Mr. " + firstName;', ), +attributes={}, +id='8113d48c0b914f17b4c6072d4dcb9dfe' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ConnectorRuleValidationResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/ConnectorRuleValidationResponse.md new file mode 100644 index 000000000..bcda0b05e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ConnectorRuleValidationResponse.md @@ -0,0 +1,41 @@ +--- +id: v2024-connector-rule-validation-response +title: ConnectorRuleValidationResponse +pagination_label: ConnectorRuleValidationResponse +sidebar_label: ConnectorRuleValidationResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConnectorRuleValidationResponse', 'V2024ConnectorRuleValidationResponse'] +slug: /tools/sdk/python/v2024/models/connector-rule-validation-response +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleValidationResponse', 'V2024ConnectorRuleValidationResponse'] +--- + +# ConnectorRuleValidationResponse + +ConnectorRuleValidationResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state** | **Enum** [ 'OK', 'ERROR' ] | | [required] +**details** | [**[]ConnectorRuleValidationResponseDetailsInner**](connector-rule-validation-response-details-inner) | | [required] +} + +## Example + +```python +from sailpoint.v2024.models.connector_rule_validation_response import ConnectorRuleValidationResponse + +connector_rule_validation_response = ConnectorRuleValidationResponse( +state='ERROR', +details=[ + sailpoint.v2024.models.connector_rule_validation_response_details_inner.ConnectorRuleValidationResponse_details_inner( + line = 2, + column = 5, + messsage = 'Remove reference to .decrypt(', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ConnectorRuleValidationResponseDetailsInner.md b/docs/tools/sdk/python/Reference/V2024/Models/ConnectorRuleValidationResponseDetailsInner.md new file mode 100644 index 000000000..5073ecee4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ConnectorRuleValidationResponseDetailsInner.md @@ -0,0 +1,38 @@ +--- +id: v2024-connector-rule-validation-response-details-inner +title: ConnectorRuleValidationResponseDetailsInner +pagination_label: ConnectorRuleValidationResponseDetailsInner +sidebar_label: ConnectorRuleValidationResponseDetailsInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ConnectorRuleValidationResponseDetailsInner', 'V2024ConnectorRuleValidationResponseDetailsInner'] +slug: /tools/sdk/python/v2024/models/connector-rule-validation-response-details-inner +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleValidationResponseDetailsInner', 'V2024ConnectorRuleValidationResponseDetailsInner'] +--- + +# ConnectorRuleValidationResponseDetailsInner + +CodeErrorDetail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**line** | **int** | The line number where the issue occurred | [required] +**column** | **int** | the column number where the issue occurred | [required] +**messsage** | **str** | a description of the issue in the code | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.connector_rule_validation_response_details_inner import ConnectorRuleValidationResponseDetailsInner + +connector_rule_validation_response_details_inner = ConnectorRuleValidationResponseDetailsInner( +line=2, +column=5, +messsage='Remove reference to .decrypt(' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ContextAttributeDto.md b/docs/tools/sdk/python/Reference/V2024/Models/ContextAttributeDto.md new file mode 100644 index 000000000..821254b3a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ContextAttributeDto.md @@ -0,0 +1,37 @@ +--- +id: v2024-context-attribute-dto +title: ContextAttributeDto +pagination_label: ContextAttributeDto +sidebar_label: ContextAttributeDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ContextAttributeDto', 'V2024ContextAttributeDto'] +slug: /tools/sdk/python/v2024/models/context-attribute-dto +tags: ['SDK', 'Software Development Kit', 'ContextAttributeDto', 'V2024ContextAttributeDto'] +--- + +# ContextAttributeDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attribute** | **str** | The name of the attribute | [optional] +**value** | [**ContextAttributeDtoValue**](context-attribute-dto-value) | | [optional] +**derived** | **bool** | True if the attribute was derived. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.context_attribute_dto import ContextAttributeDto + +context_attribute_dto = ContextAttributeDto( +attribute='location', +value=Austin, +derived=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ContextAttributeDtoValue.md b/docs/tools/sdk/python/Reference/V2024/Models/ContextAttributeDtoValue.md new file mode 100644 index 000000000..8720aeb4e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ContextAttributeDtoValue.md @@ -0,0 +1,32 @@ +--- +id: v2024-context-attribute-dto-value +title: ContextAttributeDtoValue +pagination_label: ContextAttributeDtoValue +sidebar_label: ContextAttributeDtoValue +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ContextAttributeDtoValue', 'V2024ContextAttributeDtoValue'] +slug: /tools/sdk/python/v2024/models/context-attribute-dto-value +tags: ['SDK', 'Software Development Kit', 'ContextAttributeDtoValue', 'V2024ContextAttributeDtoValue'] +--- + +# ContextAttributeDtoValue + +The value of the attribute. This can be either a string or a multi-valued string + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +} + +## Example + +```python +from sailpoint.v2024.models.context_attribute_dto_value import ContextAttributeDtoValue + +context_attribute_dto_value = ContextAttributeDtoValue( +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CorrelatedGovernanceEvent.md b/docs/tools/sdk/python/Reference/V2024/Models/CorrelatedGovernanceEvent.md new file mode 100644 index 000000000..e9433355c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CorrelatedGovernanceEvent.md @@ -0,0 +1,47 @@ +--- +id: v2024-correlated-governance-event +title: CorrelatedGovernanceEvent +pagination_label: CorrelatedGovernanceEvent +sidebar_label: CorrelatedGovernanceEvent +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CorrelatedGovernanceEvent', 'V2024CorrelatedGovernanceEvent'] +slug: /tools/sdk/python/v2024/models/correlated-governance-event +tags: ['SDK', 'Software Development Kit', 'CorrelatedGovernanceEvent', 'V2024CorrelatedGovernanceEvent'] +--- + +# CorrelatedGovernanceEvent + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the governance event, such as the certification name or access request ID. | [optional] +**dt** | **str** | The date that the certification or access request was completed. | [optional] +**type** | **Enum** [ 'certification', 'accessRequest' ] | The type of governance event. | [optional] +**governance_id** | **str** | The ID of the instance that caused the event - either the certification ID or access request ID. | [optional] +**owners** | [**[]CertifierResponse**](certifier-response) | The owners of the governance event (the certifiers or approvers) | [optional] +**reviewers** | [**[]CertifierResponse**](certifier-response) | The owners of the governance event (the certifiers or approvers), this field should be preferred over owners | [optional] +**decision_maker** | [**CertifierResponse**](certifier-response) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.correlated_governance_event import CorrelatedGovernanceEvent + +correlated_governance_event = CorrelatedGovernanceEvent( +name='Manager Certification for Jon Snow', +dt='2019-03-08T22:37:33.901Z', +type='certification', +governance_id='2c91808a77ff216301782327a50f09bf', +owners=[{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}], +reviewers=[{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}], +decision_maker=sailpoint.v2024.models.certifier_response.CertifierResponse( + id = '8a80828f643d484f01643e14202e206f', + display_name = 'John Snow', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CorrelationConfig.md b/docs/tools/sdk/python/Reference/V2024/Models/CorrelationConfig.md new file mode 100644 index 000000000..f828ca978 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CorrelationConfig.md @@ -0,0 +1,47 @@ +--- +id: v2024-correlation-config +title: CorrelationConfig +pagination_label: CorrelationConfig +sidebar_label: CorrelationConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CorrelationConfig', 'V2024CorrelationConfig'] +slug: /tools/sdk/python/v2024/models/correlation-config +tags: ['SDK', 'Software Development Kit', 'CorrelationConfig', 'V2024CorrelationConfig'] +--- + +# CorrelationConfig + +Source configuration information that is used by correlation process. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the correlation configuration. | [optional] +**name** | **str** | The name of the correlation configuration. | [optional] +**attribute_assignments** | [**[]CorrelationConfigAttributeAssignmentsInner**](correlation-config-attribute-assignments-inner) | The list of attribute assignments of the correlation configuration. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.correlation_config import CorrelationConfig + +correlation_config = CorrelationConfig( +id='2c9180835d191a86015d28455b4a2329', +name='Source [source] Account Correlation', +attribute_assignments=[ + sailpoint.v2024.models.correlation_config_attribute_assignments_inner.CorrelationConfig_attributeAssignments_inner( + property = 'first_name', + value = 'firstName', + operation = 'EQ', + complex = False, + ignore_case = False, + match_mode = 'ANYWHERE', + filter_string = 'first_name == "John"', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CorrelationConfigAttributeAssignmentsInner.md b/docs/tools/sdk/python/Reference/V2024/Models/CorrelationConfigAttributeAssignmentsInner.md new file mode 100644 index 000000000..12d9d9231 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CorrelationConfigAttributeAssignmentsInner.md @@ -0,0 +1,46 @@ +--- +id: v2024-correlation-config-attribute-assignments-inner +title: CorrelationConfigAttributeAssignmentsInner +pagination_label: CorrelationConfigAttributeAssignmentsInner +sidebar_label: CorrelationConfigAttributeAssignmentsInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CorrelationConfigAttributeAssignmentsInner', 'V2024CorrelationConfigAttributeAssignmentsInner'] +slug: /tools/sdk/python/v2024/models/correlation-config-attribute-assignments-inner +tags: ['SDK', 'Software Development Kit', 'CorrelationConfigAttributeAssignmentsInner', 'V2024CorrelationConfigAttributeAssignmentsInner'] +--- + +# CorrelationConfigAttributeAssignmentsInner + +The attribute assignment of the correlation configuration. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**var_property** | **str** | The property of the attribute assignment. | [optional] +**value** | **str** | The value of the attribute assignment. | [optional] +**operation** | **Enum** [ 'EQ' ] | The operation of the attribute assignment. | [optional] +**complex** | **bool** | Whether or not the it's a complex attribute assignment. | [optional] [default to False] +**ignore_case** | **bool** | Whether or not the attribute assignment should ignore case. | [optional] [default to False] +**match_mode** | **Enum** [ 'ANYWHERE', 'START', 'END' ] | The match mode of the attribute assignment. | [optional] +**filter_string** | **str** | The filter string of the attribute assignment. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.correlation_config_attribute_assignments_inner import CorrelationConfigAttributeAssignmentsInner + +correlation_config_attribute_assignments_inner = CorrelationConfigAttributeAssignmentsInner( +var_property='first_name', +value='firstName', +operation='EQ', +complex=False, +ignore_case=False, +match_mode='ANYWHERE', +filter_string='first_name == "John"' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CreateDomainDkim405Response.md b/docs/tools/sdk/python/Reference/V2024/Models/CreateDomainDkim405Response.md new file mode 100644 index 000000000..5faf2d7c4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CreateDomainDkim405Response.md @@ -0,0 +1,37 @@ +--- +id: v2024-create-domain-dkim405-response +title: CreateDomainDkim405Response +pagination_label: CreateDomainDkim405Response +sidebar_label: CreateDomainDkim405Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CreateDomainDkim405Response', 'V2024CreateDomainDkim405Response'] +slug: /tools/sdk/python/v2024/models/create-domain-dkim405-response +tags: ['SDK', 'Software Development Kit', 'CreateDomainDkim405Response', 'V2024CreateDomainDkim405Response'] +--- + +# CreateDomainDkim405Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error_name** | **object** | A message describing the error | [optional] +**error_message** | **object** | Description of the error | [optional] +**tracking_id** | **str** | Unique tracking id for the error. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.create_domain_dkim405_response import CreateDomainDkim405Response + +create_domain_dkim405_response = CreateDomainDkim405Response( +error_name=NotSupportedException, +error_message=Cannot consume content type, +tracking_id='e7eab60924f64aa284175b9fa3309599' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CreateExternalExecuteWorkflow200Response.md b/docs/tools/sdk/python/Reference/V2024/Models/CreateExternalExecuteWorkflow200Response.md new file mode 100644 index 000000000..7773a9902 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CreateExternalExecuteWorkflow200Response.md @@ -0,0 +1,35 @@ +--- +id: v2024-create-external-execute-workflow200-response +title: CreateExternalExecuteWorkflow200Response +pagination_label: CreateExternalExecuteWorkflow200Response +sidebar_label: CreateExternalExecuteWorkflow200Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CreateExternalExecuteWorkflow200Response', 'V2024CreateExternalExecuteWorkflow200Response'] +slug: /tools/sdk/python/v2024/models/create-external-execute-workflow200-response +tags: ['SDK', 'Software Development Kit', 'CreateExternalExecuteWorkflow200Response', 'V2024CreateExternalExecuteWorkflow200Response'] +--- + +# CreateExternalExecuteWorkflow200Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**workflow_execution_id** | **str** | The workflow execution id | [optional] +**message** | **str** | An error message if any errors occurred | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.create_external_execute_workflow200_response import CreateExternalExecuteWorkflow200Response + +create_external_execute_workflow200_response = CreateExternalExecuteWorkflow200Response( +workflow_execution_id='0e11cefa-96e7-4b67-90d0-065bc1da5753', +message='Workflow was not executed externally. Check enabled flag on workflow definition' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CreateExternalExecuteWorkflowRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/CreateExternalExecuteWorkflowRequest.md new file mode 100644 index 000000000..990d435b3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CreateExternalExecuteWorkflowRequest.md @@ -0,0 +1,33 @@ +--- +id: v2024-create-external-execute-workflow-request +title: CreateExternalExecuteWorkflowRequest +pagination_label: CreateExternalExecuteWorkflowRequest +sidebar_label: CreateExternalExecuteWorkflowRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CreateExternalExecuteWorkflowRequest', 'V2024CreateExternalExecuteWorkflowRequest'] +slug: /tools/sdk/python/v2024/models/create-external-execute-workflow-request +tags: ['SDK', 'Software Development Kit', 'CreateExternalExecuteWorkflowRequest', 'V2024CreateExternalExecuteWorkflowRequest'] +--- + +# CreateExternalExecuteWorkflowRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**input** | **object** | The input for the workflow | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.create_external_execute_workflow_request import CreateExternalExecuteWorkflowRequest + +create_external_execute_workflow_request = CreateExternalExecuteWorkflowRequest( +input={customAttribute1=value1, customAttribute2=value2} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CreateFormDefinitionFileRequestRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/CreateFormDefinitionFileRequestRequest.md new file mode 100644 index 000000000..4c467430c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CreateFormDefinitionFileRequestRequest.md @@ -0,0 +1,33 @@ +--- +id: v2024-create-form-definition-file-request-request +title: CreateFormDefinitionFileRequestRequest +pagination_label: CreateFormDefinitionFileRequestRequest +sidebar_label: CreateFormDefinitionFileRequestRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CreateFormDefinitionFileRequestRequest', 'V2024CreateFormDefinitionFileRequestRequest'] +slug: /tools/sdk/python/v2024/models/create-form-definition-file-request-request +tags: ['SDK', 'Software Development Kit', 'CreateFormDefinitionFileRequestRequest', 'V2024CreateFormDefinitionFileRequestRequest'] +--- + +# CreateFormDefinitionFileRequestRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file** | **bytearray** | File specifying the multipart | [required] +} + +## Example + +```python +from sailpoint.v2024.models.create_form_definition_file_request_request import CreateFormDefinitionFileRequestRequest + +create_form_definition_file_request_request = CreateFormDefinitionFileRequestRequest( +file=bytes(b'blah') +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CreateFormDefinitionRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/CreateFormDefinitionRequest.md new file mode 100644 index 000000000..fed55b5d0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CreateFormDefinitionRequest.md @@ -0,0 +1,87 @@ +--- +id: v2024-create-form-definition-request +title: CreateFormDefinitionRequest +pagination_label: CreateFormDefinitionRequest +sidebar_label: CreateFormDefinitionRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CreateFormDefinitionRequest', 'V2024CreateFormDefinitionRequest'] +slug: /tools/sdk/python/v2024/models/create-form-definition-request +tags: ['SDK', 'Software Development Kit', 'CreateFormDefinitionRequest', 'V2024CreateFormDefinitionRequest'] +--- + +# CreateFormDefinitionRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **str** | Description is the form definition description | [optional] +**form_conditions** | [**[]FormCondition**](form-condition) | FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form | [optional] +**form_elements** | [**[]FormElement**](form-element) | FormElements is a list of nested form elements | [optional] +**form_input** | [**[]FormDefinitionInput**](form-definition-input) | FormInput is a list of form inputs that are required when creating a form-instance object | [optional] +**name** | **str** | Name is the form definition name | [required] +**owner** | [**FormOwner**](form-owner) | | [required] +**used_by** | [**[]FormUsedBy**](form-used-by) | UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.create_form_definition_request import CreateFormDefinitionRequest + +create_form_definition_request = CreateFormDefinitionRequest( +description='My form description', +form_conditions=[ + sailpoint.v2024.models.form_condition.FormCondition( + rule_operator = 'AND', + rules = [ + sailpoint.v2024.models.condition_rule.ConditionRule( + source_type = 'ELEMENT', + source = 'department', + operator = 'EQ', + value_type = 'STRING', + value = 'Engineering', ) + ], + effects = [ + sailpoint.v2024.models.condition_effect.ConditionEffect( + effect_type = 'HIDE', + config = sailpoint.v2024.models.condition_effect_config.ConditionEffect_config( + default_value_label = 'Access to Remove', + element = '8110662963316867', ), ) + ], ) + ], +form_elements=[ + sailpoint.v2024.models.form_element.FormElement( + id = '00000000-0000-0000-0000-000000000000', + element_type = 'TEXT', + config = {label=Department}, + key = 'department', + validations = [ + sailpoint.v2024.models.form_element_validations_set.FormElementValidationsSet( + validation_type = 'REQUIRED', ) + ], ) + ], +form_input=[ + sailpoint.v2024.models.form_definition_input.FormDefinitionInput( + id = '00000000-0000-0000-0000-000000000000', + type = 'STRING', + label = 'input1', + description = 'A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic', ) + ], +name='My form', +owner=sailpoint.v2024.models.form_owner.FormOwner( + type = 'IDENTITY', + id = '2c9180867624cbd7017642d8c8c81f67', + name = 'Grant Smith', ), +used_by=[ + sailpoint.v2024.models.form_used_by.FormUsedBy( + type = 'WORKFLOW', + id = '61940a92-5484-42bc-bc10-b9982b218cdf', + name = 'Access Request Form', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CreateFormInstanceRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/CreateFormInstanceRequest.md new file mode 100644 index 000000000..2b9f22a6e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CreateFormInstanceRequest.md @@ -0,0 +1,53 @@ +--- +id: v2024-create-form-instance-request +title: CreateFormInstanceRequest +pagination_label: CreateFormInstanceRequest +sidebar_label: CreateFormInstanceRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CreateFormInstanceRequest', 'V2024CreateFormInstanceRequest'] +slug: /tools/sdk/python/v2024/models/create-form-instance-request +tags: ['SDK', 'Software Development Kit', 'CreateFormInstanceRequest', 'V2024CreateFormInstanceRequest'] +--- + +# CreateFormInstanceRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created_by** | [**FormInstanceCreatedBy**](form-instance-created-by) | | [required] +**expire** | **str** | Expire is required | [required] +**form_definition_id** | **str** | FormDefinitionID is the id of the form definition that created this form | [required] +**form_input** | **map[string]object** | FormInput is an object of form input labels to value | [optional] +**recipients** | [**[]FormInstanceRecipient**](form-instance-recipient) | Recipients is required | [required] +**stand_alone_form** | **bool** | StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form | [optional] [default to False] +**state** | **Enum** [ 'ASSIGNED', 'IN_PROGRESS', 'SUBMITTED', 'COMPLETED', 'CANCELLED' ] | State is required, if not present initial state is FormInstanceStateAssigned ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled | [optional] +**ttl** | **int** | TTL an epoch timestamp in seconds, it most be in seconds or dynamodb will ignore it SEE: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/time-to-live-ttl-before-you-start.html | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.create_form_instance_request import CreateFormInstanceRequest + +create_form_instance_request = CreateFormInstanceRequest( +created_by=sailpoint.v2024.models.form_instance_created_by.FormInstanceCreatedBy( + id = '00000000-0000-0000-0000-000000000000', + type = 'WORKFLOW_EXECUTION', ), +expire='2023-08-12T20:14:57.74486Z', +form_definition_id='00000000-0000-0000-0000-000000000000', +form_input={input1=Sales}, +recipients=[ + sailpoint.v2024.models.form_instance_recipient.FormInstanceRecipient( + id = '00000000-0000-0000-0000-000000000000', + type = 'IDENTITY', ) + ], +stand_alone_form=False, +state='ASSIGNED', +ttl=1571827560 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CreateOAuthClientRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/CreateOAuthClientRequest.md new file mode 100644 index 000000000..dc486bda4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CreateOAuthClientRequest.md @@ -0,0 +1,61 @@ +--- +id: v2024-create-o-auth-client-request +title: CreateOAuthClientRequest +pagination_label: CreateOAuthClientRequest +sidebar_label: CreateOAuthClientRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CreateOAuthClientRequest', 'V2024CreateOAuthClientRequest'] +slug: /tools/sdk/python/v2024/models/create-o-auth-client-request +tags: ['SDK', 'Software Development Kit', 'CreateOAuthClientRequest', 'V2024CreateOAuthClientRequest'] +--- + +# CreateOAuthClientRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**business_name** | **str** | The name of the business the API Client should belong to | [optional] +**homepage_url** | **str** | The homepage URL associated with the owner of the API Client | [optional] +**name** | **str** | A human-readable name for the API Client | [required] +**description** | **str** | A description of the API Client | [required] +**access_token_validity_seconds** | **int** | The number of seconds an access token generated for this API Client is valid for | [required] +**refresh_token_validity_seconds** | **int** | The number of seconds a refresh token generated for this API Client is valid for | [optional] +**redirect_uris** | **[]str** | A list of the approved redirect URIs. Provide one or more URIs when assigning the AUTHORIZATION_CODE grant type to a new OAuth Client. | [optional] +**grant_types** | [**[]GrantType**](grant-type) | A list of OAuth 2.0 grant types this API Client can be used with | [required] +**access_type** | [**AccessType**](access-type) | | [required] +**type** | [**ClientType**](client-type) | | [optional] +**internal** | **bool** | An indicator of whether the API Client can be used for requests internal within the product. | [optional] +**enabled** | **bool** | An indicator of whether the API Client is enabled for use | [required] +**strong_auth_supported** | **bool** | An indicator of whether the API Client supports strong authentication | [optional] +**claims_supported** | **bool** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | [optional] +**scope** | **[]str** | Scopes of the API Client. If no scope is specified, the client will be created with the default scope \"sp:scopes:all\". This means the API Client will have all the rights of the owner who created it. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.create_o_auth_client_request import CreateOAuthClientRequest + +create_o_auth_client_request = CreateOAuthClientRequest( +business_name='Acme-Solar', +homepage_url='http://localhost:12345', +name='Demo API Client', +description='An API client used for the authorization_code, refresh_token, and client_credentials flows', +access_token_validity_seconds=750, +refresh_token_validity_seconds=86400, +redirect_uris=[http://localhost:12345], +grant_types=[AUTHORIZATION_CODE, CLIENT_CREDENTIALS, REFRESH_TOKEN], +access_type='OFFLINE', +type='CONFIDENTIAL', +internal=False, +enabled=True, +strong_auth_supported=False, +claims_supported=False, +scope=[demo:api-client-scope:first, demo:api-client-scope:second] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CreateOAuthClientResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/CreateOAuthClientResponse.md new file mode 100644 index 000000000..c6b37af78 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CreateOAuthClientResponse.md @@ -0,0 +1,69 @@ +--- +id: v2024-create-o-auth-client-response +title: CreateOAuthClientResponse +pagination_label: CreateOAuthClientResponse +sidebar_label: CreateOAuthClientResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CreateOAuthClientResponse', 'V2024CreateOAuthClientResponse'] +slug: /tools/sdk/python/v2024/models/create-o-auth-client-response +tags: ['SDK', 'Software Development Kit', 'CreateOAuthClientResponse', 'V2024CreateOAuthClientResponse'] +--- + +# CreateOAuthClientResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the OAuth client | [required] +**secret** | **str** | Secret of the OAuth client (This field is only returned on the intial create call.) | [required] +**business_name** | **str** | The name of the business the API Client should belong to | [required] +**homepage_url** | **str** | The homepage URL associated with the owner of the API Client | [required] +**name** | **str** | A human-readable name for the API Client | [required] +**description** | **str** | A description of the API Client | [required] +**access_token_validity_seconds** | **int** | The number of seconds an access token generated for this API Client is valid for | [required] +**refresh_token_validity_seconds** | **int** | The number of seconds a refresh token generated for this API Client is valid for | [required] +**redirect_uris** | **[]str** | A list of the approved redirect URIs used with the authorization_code flow | [required] +**grant_types** | [**[]GrantType**](grant-type) | A list of OAuth 2.0 grant types this API Client can be used with | [required] +**access_type** | [**AccessType**](access-type) | | [required] +**type** | [**ClientType**](client-type) | | [required] +**internal** | **bool** | An indicator of whether the API Client can be used for requests internal to IDN | [required] +**enabled** | **bool** | An indicator of whether the API Client is enabled for use | [required] +**strong_auth_supported** | **bool** | An indicator of whether the API Client supports strong authentication | [required] +**claims_supported** | **bool** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | [required] +**created** | **datetime** | The date and time, down to the millisecond, when the API Client was created | [required] +**modified** | **datetime** | The date and time, down to the millisecond, when the API Client was last updated | [required] +**scope** | **[]str** | Scopes of the API Client. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.create_o_auth_client_response import CreateOAuthClientResponse + +create_o_auth_client_response = CreateOAuthClientResponse( +id='2c9180835d2e5168015d32f890ca1581', +secret='5c32dd9b21adb51c77794d46e71de117a1d0ddb36a7ff941fa28014ab7de2cf3', +business_name='Acme-Solar', +homepage_url='http://localhost:12345', +name='Demo API Client', +description='An API client used for the authorization_code, refresh_token, and client_credentials flows', +access_token_validity_seconds=750, +refresh_token_validity_seconds=86400, +redirect_uris=[http://localhost:12345], +grant_types=[AUTHORIZATION_CODE, CLIENT_CREDENTIALS, REFRESH_TOKEN], +access_type='OFFLINE', +type='CONFIDENTIAL', +internal=False, +enabled=True, +strong_auth_supported=False, +claims_supported=False, +created='2017-07-11T18:45:37.098Z', +modified='2018-06-25T20:22:28.104Z', +scope=[demo:api-client-scope:first, demo:api-client-scope:second] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CreatePersonalAccessTokenRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/CreatePersonalAccessTokenRequest.md new file mode 100644 index 000000000..ae87435ef --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CreatePersonalAccessTokenRequest.md @@ -0,0 +1,38 @@ +--- +id: v2024-create-personal-access-token-request +title: CreatePersonalAccessTokenRequest +pagination_label: CreatePersonalAccessTokenRequest +sidebar_label: CreatePersonalAccessTokenRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CreatePersonalAccessTokenRequest', 'V2024CreatePersonalAccessTokenRequest'] +slug: /tools/sdk/python/v2024/models/create-personal-access-token-request +tags: ['SDK', 'Software Development Kit', 'CreatePersonalAccessTokenRequest', 'V2024CreatePersonalAccessTokenRequest'] +--- + +# CreatePersonalAccessTokenRequest + +Object for specifying the name of a personal access token to create + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created. | [required] +**scope** | **[]str** | Scopes of the personal access token. If no scope is specified, the token will be created with the default scope \"sp:scopes:all\". This means the personal access token will have all the rights of the owner who created it. | [optional] +**access_token_validity_seconds** | **int** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.create_personal_access_token_request import CreatePersonalAccessTokenRequest + +create_personal_access_token_request = CreatePersonalAccessTokenRequest( +name='NodeJS Integration', +scope=[demo:personal-access-token-scope:first, demo:personal-access-token-scope:second], +access_token_validity_seconds=36900 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CreatePersonalAccessTokenResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/CreatePersonalAccessTokenResponse.md new file mode 100644 index 000000000..97a18f43f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CreatePersonalAccessTokenResponse.md @@ -0,0 +1,48 @@ +--- +id: v2024-create-personal-access-token-response +title: CreatePersonalAccessTokenResponse +pagination_label: CreatePersonalAccessTokenResponse +sidebar_label: CreatePersonalAccessTokenResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CreatePersonalAccessTokenResponse', 'V2024CreatePersonalAccessTokenResponse'] +slug: /tools/sdk/python/v2024/models/create-personal-access-token-response +tags: ['SDK', 'Software Development Kit', 'CreatePersonalAccessTokenResponse', 'V2024CreatePersonalAccessTokenResponse'] +--- + +# CreatePersonalAccessTokenResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the personal access token (to be used as the username for Basic Auth). | [required] +**secret** | **str** | The secret of the personal access token (to be used as the password for Basic Auth). | [required] +**scope** | **[]str** | Scopes of the personal access token. | [required] +**name** | **str** | The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. | [required] +**owner** | [**PatOwner**](pat-owner) | | [required] +**created** | **datetime** | The date and time, down to the millisecond, when this personal access token was created. | [required] +**access_token_validity_seconds** | **int** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.create_personal_access_token_response import CreatePersonalAccessTokenResponse + +create_personal_access_token_response = CreatePersonalAccessTokenResponse( +id='86f1dc6fe8f54414950454cbb11278fa', +secret='1d1bef2b9f426383447f64f69349fc7cac176042578d205c256ba3f37c59adb9', +scope=[demo:personal-access-token-scope:first, demo:personal-access-token-scope:second], +name='NodeJS Integration', +owner=sailpoint.v2024.models.pat_owner.PatOwner( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', ), +created='2017-07-11T18:45:37.098Z', +access_token_validity_seconds=36900 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CreateSavedSearchRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/CreateSavedSearchRequest.md new file mode 100644 index 000000000..7d9dc7499 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CreateSavedSearchRequest.md @@ -0,0 +1,53 @@ +--- +id: v2024-create-saved-search-request +title: CreateSavedSearchRequest +pagination_label: CreateSavedSearchRequest +sidebar_label: CreateSavedSearchRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CreateSavedSearchRequest', 'V2024CreateSavedSearchRequest'] +slug: /tools/sdk/python/v2024/models/create-saved-search-request +tags: ['SDK', 'Software Development Kit', 'CreateSavedSearchRequest', 'V2024CreateSavedSearchRequest'] +--- + +# CreateSavedSearchRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the saved search. | [optional] +**description** | **str** | The description of the saved search. | [optional] +**created** | **datetime** | A date-time in ISO-8601 format | [optional] +**modified** | **datetime** | A date-time in ISO-8601 format | [optional] +**indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | [required] +**columns** | [**map[string]List[Column]**](https://docs.python.org/3/tutorial/datastructures.html#more-on-lists) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional] +**query** | **str** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | [required] +**fields** | **[]str** | The fields to be searched against in a multi-field query. | [optional] +**order_by** | **map[string]List[str]** | Sort by index. This takes precedence over the `sort` property. | [optional] +**sort** | **[]str** | The fields to be used to sort the search results. | [optional] +**filters** | [**SavedSearchDetailFilters**](saved-search-detail-filters) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.create_saved_search_request import CreateSavedSearchRequest + +create_saved_search_request = CreateSavedSearchRequest( +name='Disabled accounts', +description='Disabled accounts', +created='2018-06-25T20:22:28.104Z', +modified='2018-06-25T20:22:28.104Z', +indices=[identities], +columns={identity=[{field=displayName, header=Display Name}, {field=e-mail, header=Work Email}]}, +query='@accounts(disabled:true)', +fields=[disabled], +order_by={identity=[lastName, firstName], role=[name]}, +sort=[displayName], +filters= +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CreateScheduledSearchRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/CreateScheduledSearchRequest.md new file mode 100644 index 000000000..fe1b3ac4b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CreateScheduledSearchRequest.md @@ -0,0 +1,61 @@ +--- +id: v2024-create-scheduled-search-request +title: CreateScheduledSearchRequest +pagination_label: CreateScheduledSearchRequest +sidebar_label: CreateScheduledSearchRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CreateScheduledSearchRequest', 'V2024CreateScheduledSearchRequest'] +slug: /tools/sdk/python/v2024/models/create-scheduled-search-request +tags: ['SDK', 'Software Development Kit', 'CreateScheduledSearchRequest', 'V2024CreateScheduledSearchRequest'] +--- + +# CreateScheduledSearchRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the scheduled search. | [optional] +**description** | **str** | The description of the scheduled search. | [optional] +**saved_search_id** | **str** | The ID of the saved search that will be executed. | [required] +**created** | **datetime** | The date the scheduled search was initially created. | [optional] [readonly] +**modified** | **datetime** | The last date the scheduled search was modified. | [optional] [readonly] +**schedule** | [**Schedule2**](schedule2) | | [required] +**recipients** | [**[]SearchScheduleRecipientsInner**](search-schedule-recipients-inner) | A list of identities that should receive the scheduled search report via email. | [required] +**enabled** | **bool** | Indicates if the scheduled search is enabled. | [optional] [default to False] +**email_empty_results** | **bool** | Indicates if email generation should occur when search returns no results. | [optional] [default to False] +**display_query_details** | **bool** | Indicates if the generated email should include the query and search results preview (which could include PII). | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.create_scheduled_search_request import CreateScheduledSearchRequest + +create_scheduled_search_request = CreateScheduledSearchRequest( +name='Daily disabled accounts', +description='Daily disabled accounts', +saved_search_id='554f1511-f0a1-4744-ab14-599514d3e57c', +created='2018-06-25T20:22:28.104Z', +modified='2018-06-25T20:22:28.104Z', +schedule=sailpoint.v2024.models.schedule_2.Schedule_2( + type = 'WEEKLY', + months = null, + days = null, + hours = null, + expiration = '2018-06-25T20:22:28.104Z', + time_zone_id = 'America/Chicago', ), +recipients=[ + sailpoint.v2024.models.search_schedule_recipients_inner.SearchSchedule_recipients_inner( + type = 'IDENTITY', + id = '2c9180867624cbd7017642d8c8c81f67', ) + ], +enabled=False, +email_empty_results=False, +display_query_details=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CreateUploadedConfigurationRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/CreateUploadedConfigurationRequest.md new file mode 100644 index 000000000..093c785d3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CreateUploadedConfigurationRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-create-uploaded-configuration-request +title: CreateUploadedConfigurationRequest +pagination_label: CreateUploadedConfigurationRequest +sidebar_label: CreateUploadedConfigurationRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CreateUploadedConfigurationRequest', 'V2024CreateUploadedConfigurationRequest'] +slug: /tools/sdk/python/v2024/models/create-uploaded-configuration-request +tags: ['SDK', 'Software Development Kit', 'CreateUploadedConfigurationRequest', 'V2024CreateUploadedConfigurationRequest'] +--- + +# CreateUploadedConfigurationRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | **bytearray** | JSON file containing the objects to be imported. | [required] +**name** | **str** | Name that will be assigned to the uploaded configuration file. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.create_uploaded_configuration_request import CreateUploadedConfigurationRequest + +create_uploaded_configuration_request = CreateUploadedConfigurationRequest( +data=bytes(b'blah'), +name='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CreateWorkflowRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/CreateWorkflowRequest.md new file mode 100644 index 000000000..3708329da --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CreateWorkflowRequest.md @@ -0,0 +1,51 @@ +--- +id: v2024-create-workflow-request +title: CreateWorkflowRequest +pagination_label: CreateWorkflowRequest +sidebar_label: CreateWorkflowRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CreateWorkflowRequest', 'V2024CreateWorkflowRequest'] +slug: /tools/sdk/python/v2024/models/create-workflow-request +tags: ['SDK', 'Software Development Kit', 'CreateWorkflowRequest', 'V2024CreateWorkflowRequest'] +--- + +# CreateWorkflowRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the workflow | [required] +**owner** | [**WorkflowBodyOwner**](workflow-body-owner) | | [optional] +**description** | **str** | Description of what the workflow accomplishes | [optional] +**definition** | [**WorkflowDefinition**](workflow-definition) | | [optional] +**enabled** | **bool** | Enable or disable the workflow. Workflows cannot be created in an enabled state. | [optional] [default to False] +**trigger** | [**WorkflowTrigger**](workflow-trigger) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.create_workflow_request import CreateWorkflowRequest + +create_workflow_request = CreateWorkflowRequest( +name='Send Email', +owner=sailpoint.v2024.models.workflow_body_owner.WorkflowBody_owner( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), +description='Send an email to the identity who's attributes changed.', +definition=sailpoint.v2024.models.workflow_definition.WorkflowDefinition( + start = 'Send Email Test', + steps = {Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=ACTION}, success={type=success}}, ), +enabled=False, +trigger=sailpoint.v2024.models.workflow_trigger.WorkflowTrigger( + type = 'EVENT', + display_name = '', + attributes = null, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CriteriaType.md b/docs/tools/sdk/python/Reference/V2024/Models/CriteriaType.md new file mode 100644 index 000000000..2fd7b20cc --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CriteriaType.md @@ -0,0 +1,41 @@ +--- +id: v2024-criteria-type +title: CriteriaType +pagination_label: CriteriaType +sidebar_label: CriteriaType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CriteriaType', 'V2024CriteriaType'] +slug: /tools/sdk/python/v2024/models/criteria-type +tags: ['SDK', 'Software Development Kit', 'CriteriaType', 'V2024CriteriaType'] +--- + +# CriteriaType + +Type of the criteria in the filter. The `COMPOSITE` filter can contain multiple filters in an AND/OR relationship. + +## Enum + +* `COMPOSITE` (value: `'COMPOSITE'`) + +* `ROLE` (value: `'ROLE'`) + +* `IDENTITY` (value: `'IDENTITY'`) + +* `IDENTITY_ATTRIBUTE` (value: `'IDENTITY_ATTRIBUTE'`) + +* `ENTITLEMENT` (value: `'ENTITLEMENT'`) + +* `ACCESS_PROFILE` (value: `'ACCESS_PROFILE'`) + +* `SOURCE` (value: `'SOURCE'`) + +* `ACCOUNT` (value: `'ACCOUNT'`) + +* `AGGREGATED_ENTITLEMENT` (value: `'AGGREGATED_ENTITLEMENT'`) + +* `INVALID_CERTIFIABLE_ENTITY` (value: `'INVALID_CERTIFIABLE_ENTITY'`) + +* `INVALID_CERTIFIABLE_BUNDLE` (value: `'INVALID_CERTIFIABLE_BUNDLE'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/CustomPasswordInstruction.md b/docs/tools/sdk/python/Reference/V2024/Models/CustomPasswordInstruction.md new file mode 100644 index 000000000..51eb75069 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/CustomPasswordInstruction.md @@ -0,0 +1,37 @@ +--- +id: v2024-custom-password-instruction +title: CustomPasswordInstruction +pagination_label: CustomPasswordInstruction +sidebar_label: CustomPasswordInstruction +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CustomPasswordInstruction', 'V2024CustomPasswordInstruction'] +slug: /tools/sdk/python/v2024/models/custom-password-instruction +tags: ['SDK', 'Software Development Kit', 'CustomPasswordInstruction', 'V2024CustomPasswordInstruction'] +--- + +# CustomPasswordInstruction + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**page_id** | **Enum** [ 'change-password:enter-password', 'change-password:finish', 'flow-selection:select', 'forget-username:user-email', 'mfa:enter-code', 'mfa:enter-kba', 'mfa:select', 'reset-password:enter-password', 'reset-password:enter-username', 'reset-password:finish', 'unlock-account:enter-username', 'unlock-account:finish' ] | The page ID that represents the page for forget user name, reset password and unlock account flow. | [optional] +**page_content** | **str** | The custom instructions for the specified page. Allow basic HTML format and maximum length is 1000 characters. The custom instructions will be sanitized to avoid attacks. If the customization text includes a link, like `...` clicking on this will open the link on the current browser page. If you want your link to be redirected to a different page, please redirect it to \"_blank\" like this: `link`. This will open a new tab when the link is clicked. Notice we're only supporting _blank as the redirection target. | [optional] +**locale** | **str** | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.custom_password_instruction import CustomPasswordInstruction + +custom_password_instruction = CustomPasswordInstruction( +page_id='change-password:enter-password', +page_content='Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter.', +locale='en' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/DataAccess.md b/docs/tools/sdk/python/Reference/V2024/Models/DataAccess.md new file mode 100644 index 000000000..08c9711e7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/DataAccess.md @@ -0,0 +1,46 @@ +--- +id: v2024-data-access +title: DataAccess +pagination_label: DataAccess +sidebar_label: DataAccess +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DataAccess', 'V2024DataAccess'] +slug: /tools/sdk/python/v2024/models/data-access +tags: ['SDK', 'Software Development Kit', 'DataAccess', 'V2024DataAccess'] +--- + +# DataAccess + +DAS data for the entitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**policies** | [**[]DataAccessPoliciesInner**](data-access-policies-inner) | List of classification policies that apply to resources the entitlement \\ groups has access to | [optional] +**categories** | [**[]DataAccessCategoriesInner**](data-access-categories-inner) | List of classification categories that apply to resources the entitlement \\ groups has access to | [optional] +**impact_score** | [**DataAccessImpactScore**](data-access-impact-score) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.data_access import DataAccess + +data_access = DataAccess( +policies=[ + sailpoint.v2024.models.data_access_policies_inner.DataAccess_policies_inner( + value = 'GDPR-20', ) + ], +categories=[ + sailpoint.v2024.models.data_access_categories_inner.DataAccess_categories_inner( + value = 'email-7', + match_count = 10, ) + ], +impact_score=sailpoint.v2024.models.data_access_impact_score.DataAccess_impactScore( + value = 'Medium', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/DataAccessCategoriesInner.md b/docs/tools/sdk/python/Reference/V2024/Models/DataAccessCategoriesInner.md new file mode 100644 index 000000000..ea3a7a629 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/DataAccessCategoriesInner.md @@ -0,0 +1,35 @@ +--- +id: v2024-data-access-categories-inner +title: DataAccessCategoriesInner +pagination_label: DataAccessCategoriesInner +sidebar_label: DataAccessCategoriesInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DataAccessCategoriesInner', 'V2024DataAccessCategoriesInner'] +slug: /tools/sdk/python/v2024/models/data-access-categories-inner +tags: ['SDK', 'Software Development Kit', 'DataAccessCategoriesInner', 'V2024DataAccessCategoriesInner'] +--- + +# DataAccessCategoriesInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | Value of the category | [optional] +**match_count** | **int** | Number of matched for each category | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.data_access_categories_inner import DataAccessCategoriesInner + +data_access_categories_inner = DataAccessCategoriesInner( +value='email-7', +match_count=10 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/DataAccessImpactScore.md b/docs/tools/sdk/python/Reference/V2024/Models/DataAccessImpactScore.md new file mode 100644 index 000000000..b8b4033cd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/DataAccessImpactScore.md @@ -0,0 +1,33 @@ +--- +id: v2024-data-access-impact-score +title: DataAccessImpactScore +pagination_label: DataAccessImpactScore +sidebar_label: DataAccessImpactScore +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DataAccessImpactScore', 'V2024DataAccessImpactScore'] +slug: /tools/sdk/python/v2024/models/data-access-impact-score +tags: ['SDK', 'Software Development Kit', 'DataAccessImpactScore', 'V2024DataAccessImpactScore'] +--- + +# DataAccessImpactScore + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | Impact Score for this data | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.data_access_impact_score import DataAccessImpactScore + +data_access_impact_score = DataAccessImpactScore( +value='Medium' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/DataAccessPoliciesInner.md b/docs/tools/sdk/python/Reference/V2024/Models/DataAccessPoliciesInner.md new file mode 100644 index 000000000..9216f9e22 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/DataAccessPoliciesInner.md @@ -0,0 +1,33 @@ +--- +id: v2024-data-access-policies-inner +title: DataAccessPoliciesInner +pagination_label: DataAccessPoliciesInner +sidebar_label: DataAccessPoliciesInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DataAccessPoliciesInner', 'V2024DataAccessPoliciesInner'] +slug: /tools/sdk/python/v2024/models/data-access-policies-inner +tags: ['SDK', 'Software Development Kit', 'DataAccessPoliciesInner', 'V2024DataAccessPoliciesInner'] +--- + +# DataAccessPoliciesInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | Value of the policy | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.data_access_policies_inner import DataAccessPoliciesInner + +data_access_policies_inner = DataAccessPoliciesInner( +value='GDPR-20' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/DataSegment.md b/docs/tools/sdk/python/Reference/V2024/Models/DataSegment.md new file mode 100644 index 000000000..be84147a6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/DataSegment.md @@ -0,0 +1,59 @@ +--- +id: v2024-data-segment +title: DataSegment +pagination_label: DataSegment +sidebar_label: DataSegment +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DataSegment', 'V2024DataSegment'] +slug: /tools/sdk/python/v2024/models/data-segment +tags: ['SDK', 'Software Development Kit', 'DataSegment', 'V2024DataSegment'] +--- + +# DataSegment + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The segment's ID. | [optional] +**name** | **str** | The segment's business name. | [optional] +**created** | **datetime** | The time when the segment is created. | [optional] +**modified** | **datetime** | The time when the segment is modified. | [optional] +**description** | **str** | The segment's optional description. | [optional] +**scopes** | [**[]Scope**](scope) | List of Scopes that are assigned to the segment | [optional] +**member_selection** | [**[]Ref**](ref) | List of Identities that are assigned to the segment | [optional] +**member_filter** | [**VisibilityCriteria**](visibility-criteria) | | [optional] +**membership** | [**MembershipType**](membership-type) | | [optional] +**enabled** | **bool** | This boolean indicates whether the segment is currently active. Inactive segments have no effect. | [optional] [default to False] +**published** | **bool** | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified to until published | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.data_segment import DataSegment + +data_segment = DataSegment( +id='0f11f2a4-7c94-4bf3-a2bd-742580fe3bde', +name='segment-xyz', +created='2020-01-01T00:00Z', +modified='2020-01-01T00:00Z', +description='This segment represents xyz', +scopes=[{scope=ENTITLEMENT, visibility=SELECTION, scopeFilter=null, scopeSelection=[{type=ENTITLEMENT, id=34d73f611449463ea4fdcf02cda0c397}]}], +member_selection=[{type=IDENTITY, id=29cb6c061da843ea8be4b3125f248f2a}, {type=IDENTITY, id=f7b1b8a35fed4fd4ad2982014e137e19}], +member_filter=sailpoint.v2024.models.visibility_criteria.VisibilityCriteria( + expression = sailpoint.v2024.models.expression.Expression( + operator = 'EQUALS', + attribute = 'location', + value = sailpoint.v2024.models.value.Value( + type = 'STRING', ), + children = [], ), ), +membership='ALL', +enabled=True, +published=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/DeleteNonEmployeeRecordsInBulkRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/DeleteNonEmployeeRecordsInBulkRequest.md new file mode 100644 index 000000000..adaf87d6a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/DeleteNonEmployeeRecordsInBulkRequest.md @@ -0,0 +1,33 @@ +--- +id: v2024-delete-non-employee-records-in-bulk-request +title: DeleteNonEmployeeRecordsInBulkRequest +pagination_label: DeleteNonEmployeeRecordsInBulkRequest +sidebar_label: DeleteNonEmployeeRecordsInBulkRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DeleteNonEmployeeRecordsInBulkRequest', 'V2024DeleteNonEmployeeRecordsInBulkRequest'] +slug: /tools/sdk/python/v2024/models/delete-non-employee-records-in-bulk-request +tags: ['SDK', 'Software Development Kit', 'DeleteNonEmployeeRecordsInBulkRequest', 'V2024DeleteNonEmployeeRecordsInBulkRequest'] +--- + +# DeleteNonEmployeeRecordsInBulkRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ids** | **[]str** | List of non-employee ids. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.delete_non_employee_records_in_bulk_request import DeleteNonEmployeeRecordsInBulkRequest + +delete_non_employee_records_in_bulk_request = DeleteNonEmployeeRecordsInBulkRequest( +ids=[2b838de9-db9b-abcf-e646-d4f274ad4238, 2d838de9-db9b-abcf-e646-d4f274ad4238] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/DeleteSource202Response.md b/docs/tools/sdk/python/Reference/V2024/Models/DeleteSource202Response.md new file mode 100644 index 000000000..37cb8da8e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/DeleteSource202Response.md @@ -0,0 +1,37 @@ +--- +id: v2024-delete-source202-response +title: DeleteSource202Response +pagination_label: DeleteSource202Response +sidebar_label: DeleteSource202Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DeleteSource202Response', 'V2024DeleteSource202Response'] +slug: /tools/sdk/python/v2024/models/delete-source202-response +tags: ['SDK', 'Software Development Kit', 'DeleteSource202Response', 'V2024DeleteSource202Response'] +--- + +# DeleteSource202Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'TASK_RESULT' ] | Type of object being referenced. | [optional] +**id** | **str** | Task result ID. | [optional] +**name** | **str** | Task result's human-readable display name (this should be null/empty). | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.delete_source202_response import DeleteSource202Response + +delete_source202_response = DeleteSource202Response( +type='TASK_RESULT', +id='2c91808779ecf55b0179f720942f181a', +name='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/DeleteVendorConnectorMapping200Response.md b/docs/tools/sdk/python/Reference/V2024/Models/DeleteVendorConnectorMapping200Response.md new file mode 100644 index 000000000..f9ce4e56a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/DeleteVendorConnectorMapping200Response.md @@ -0,0 +1,33 @@ +--- +id: v2024-delete-vendor-connector-mapping200-response +title: DeleteVendorConnectorMapping200Response +pagination_label: DeleteVendorConnectorMapping200Response +sidebar_label: DeleteVendorConnectorMapping200Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DeleteVendorConnectorMapping200Response', 'V2024DeleteVendorConnectorMapping200Response'] +slug: /tools/sdk/python/v2024/models/delete-vendor-connector-mapping200-response +tags: ['SDK', 'Software Development Kit', 'DeleteVendorConnectorMapping200Response', 'V2024DeleteVendorConnectorMapping200Response'] +--- + +# DeleteVendorConnectorMapping200Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**count** | **int** | The number of vendor connector mappings successfully deleted. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.delete_vendor_connector_mapping200_response import DeleteVendorConnectorMapping200Response + +delete_vendor_connector_mapping200_response = DeleteVendorConnectorMapping200Response( +count=1 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/DependantAppConnections.md b/docs/tools/sdk/python/Reference/V2024/Models/DependantAppConnections.md new file mode 100644 index 000000000..cc721bb74 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/DependantAppConnections.md @@ -0,0 +1,61 @@ +--- +id: v2024-dependant-app-connections +title: DependantAppConnections +pagination_label: DependantAppConnections +sidebar_label: DependantAppConnections +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DependantAppConnections', 'V2024DependantAppConnections'] +slug: /tools/sdk/python/v2024/models/dependant-app-connections +tags: ['SDK', 'Software Development Kit', 'DependantAppConnections', 'V2024DependantAppConnections'] +--- + +# DependantAppConnections + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cloud_app_id** | **str** | Id of the connected Application | [optional] +**description** | **str** | Description of the connected Application | [optional] +**enabled** | **bool** | Is the Application enabled | [optional] [default to True] +**provision_request_enabled** | **bool** | Is Provisioning enabled for connected Application | [optional] [default to True] +**account_source** | [**DependantAppConnectionsAccountSource**](dependant-app-connections-account-source) | | [optional] +**launcher_count** | **int** | The amount of launchers for connected Application (long type) | [optional] +**match_all_account** | **bool** | Is Provisioning enabled for connected Application | [optional] [default to False] +**owner** | [**[]BaseReferenceDto**](base-reference-dto) | The owner of the connected Application | [optional] +**app_center_enabled** | **bool** | Is App Center enabled for connected Application | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.dependant_app_connections import DependantAppConnections + +dependant_app_connections = DependantAppConnections( +cloud_app_id='9e3cdd80edf84f119327df8bbd5bb5ac', +description='This is a Sailpoint application', +enabled=True, +provision_request_enabled=True, +account_source=sailpoint.v2024.models.dependant_app_connections_account_source.DependantAppConnections_accountSource( + use_for_password_management = False, + password_policies = [ + sailpoint.v2024.models.dependant_app_connections_account_source_password_policies_inner.DependantAppConnections_accountSource_passwordPolicies_inner( + type = 'PASSWORD_POLICY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'Policy ODS', ) + ], ), +launcher_count=100, +match_all_account=True, +owner=[ + sailpoint.v2024.models.base_reference_dto.BaseReferenceDto( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ) + ], +app_center_enabled=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/DependantAppConnectionsAccountSource.md b/docs/tools/sdk/python/Reference/V2024/Models/DependantAppConnectionsAccountSource.md new file mode 100644 index 000000000..0fd245236 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/DependantAppConnectionsAccountSource.md @@ -0,0 +1,41 @@ +--- +id: v2024-dependant-app-connections-account-source +title: DependantAppConnectionsAccountSource +pagination_label: DependantAppConnectionsAccountSource +sidebar_label: DependantAppConnectionsAccountSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DependantAppConnectionsAccountSource', 'V2024DependantAppConnectionsAccountSource'] +slug: /tools/sdk/python/v2024/models/dependant-app-connections-account-source +tags: ['SDK', 'Software Development Kit', 'DependantAppConnectionsAccountSource', 'V2024DependantAppConnectionsAccountSource'] +--- + +# DependantAppConnectionsAccountSource + +The Account Source of the connected Application + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**use_for_password_management** | **bool** | Use this Account Source for password management | [optional] [default to False] +**password_policies** | [**[]DependantAppConnectionsAccountSourcePasswordPoliciesInner**](dependant-app-connections-account-source-password-policies-inner) | A list of Password Policies for this Account Source | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.dependant_app_connections_account_source import DependantAppConnectionsAccountSource + +dependant_app_connections_account_source = DependantAppConnectionsAccountSource( +use_for_password_management=False, +password_policies=[ + sailpoint.v2024.models.dependant_app_connections_account_source_password_policies_inner.DependantAppConnections_accountSource_passwordPolicies_inner( + type = 'PASSWORD_POLICY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'Policy ODS', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/DependantAppConnectionsAccountSourcePasswordPoliciesInner.md b/docs/tools/sdk/python/Reference/V2024/Models/DependantAppConnectionsAccountSourcePasswordPoliciesInner.md new file mode 100644 index 000000000..5da4e92de --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/DependantAppConnectionsAccountSourcePasswordPoliciesInner.md @@ -0,0 +1,37 @@ +--- +id: v2024-dependant-app-connections-account-source-password-policies-inner +title: DependantAppConnectionsAccountSourcePasswordPoliciesInner +pagination_label: DependantAppConnectionsAccountSourcePasswordPoliciesInner +sidebar_label: DependantAppConnectionsAccountSourcePasswordPoliciesInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DependantAppConnectionsAccountSourcePasswordPoliciesInner', 'V2024DependantAppConnectionsAccountSourcePasswordPoliciesInner'] +slug: /tools/sdk/python/v2024/models/dependant-app-connections-account-source-password-policies-inner +tags: ['SDK', 'Software Development Kit', 'DependantAppConnectionsAccountSourcePasswordPoliciesInner', 'V2024DependantAppConnectionsAccountSourcePasswordPoliciesInner'] +--- + +# DependantAppConnectionsAccountSourcePasswordPoliciesInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | DTO type | [optional] +**id** | **str** | ID of the object to which this reference applies | [optional] +**name** | **str** | Human-readable display name of the object to which this reference applies | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.dependant_app_connections_account_source_password_policies_inner import DependantAppConnectionsAccountSourcePasswordPoliciesInner + +dependant_app_connections_account_source_password_policies_inner = DependantAppConnectionsAccountSourcePasswordPoliciesInner( +type='PASSWORD_POLICY', +id='2c91808568c529c60168cca6f90c1313', +name='Policy ODS' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/DependantConnectionsMissingDto.md b/docs/tools/sdk/python/Reference/V2024/Models/DependantConnectionsMissingDto.md new file mode 100644 index 000000000..90293d076 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/DependantConnectionsMissingDto.md @@ -0,0 +1,35 @@ +--- +id: v2024-dependant-connections-missing-dto +title: DependantConnectionsMissingDto +pagination_label: DependantConnectionsMissingDto +sidebar_label: DependantConnectionsMissingDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DependantConnectionsMissingDto', 'V2024DependantConnectionsMissingDto'] +slug: /tools/sdk/python/v2024/models/dependant-connections-missing-dto +tags: ['SDK', 'Software Development Kit', 'DependantConnectionsMissingDto', 'V2024DependantConnectionsMissingDto'] +--- + +# DependantConnectionsMissingDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**dependency_type** | **Enum** [ 'identityProfiles', 'credentialProfiles', 'mappingProfiles', 'sourceAttributes', 'dependantCustomTransforms', 'dependantApps' ] | The type of dependency type that is missing in the SourceConnections | [optional] +**reason** | **str** | The reason why this dependency is missing | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.dependant_connections_missing_dto import DependantConnectionsMissingDto + +dependant_connections_missing_dto = DependantConnectionsMissingDto( +dependency_type='dependantApps', +reason='If there was an error retrieving any dependencies, it would lbe listed here' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/DeployRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/DeployRequest.md new file mode 100644 index 000000000..5a723b5cf --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/DeployRequest.md @@ -0,0 +1,33 @@ +--- +id: v2024-deploy-request +title: DeployRequest +pagination_label: DeployRequest +sidebar_label: DeployRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DeployRequest', 'V2024DeployRequest'] +slug: /tools/sdk/python/v2024/models/deploy-request +tags: ['SDK', 'Software Development Kit', 'DeployRequest', 'V2024DeployRequest'] +--- + +# DeployRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**draft_id** | **str** | The id of the draft to be used by this deploy. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.deploy_request import DeployRequest + +deploy_request = DeployRequest( +draft_id='3d0fe04b-57df-4a46-a83b-8f04b0f9d10b' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/DeployResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/DeployResponse.md new file mode 100644 index 000000000..09f4ad226 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/DeployResponse.md @@ -0,0 +1,55 @@ +--- +id: v2024-deploy-response +title: DeployResponse +pagination_label: DeployResponse +sidebar_label: DeployResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DeployResponse', 'V2024DeployResponse'] +slug: /tools/sdk/python/v2024/models/deploy-response +tags: ['SDK', 'Software Development Kit', 'DeployResponse', 'V2024DeployResponse'] +--- + +# DeployResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**job_id** | **str** | Unique id assigned to this job. | [optional] +**status** | **Enum** [ 'NOT_STARTED', 'IN_PROGRESS', 'COMPLETE', 'CANCELLED', 'FAILED' ] | Status of the job. | [optional] +**type** | **Enum** [ 'CONFIG_DEPLOY_DRAFT' ] | Type of the job, will always be CONFIG_DEPLOY_DRAFT for this type of job. | [optional] +**message** | **str** | Message providing information about the outcome of the deploy process. | [optional] +**requester_name** | **str** | The name of the user that initiated the deploy process. | [optional] +**file_exists** | **bool** | Whether or not a results file was created and stored for this deploy. | [optional] [default to True] +**created** | **datetime** | The time the job was started. | [optional] +**modified** | **datetime** | The time of the last update to the job. | [optional] +**completed** | **datetime** | The time the job was completed. | [optional] +**draft_id** | **str** | The id of the draft that was used for this deploy. | [optional] +**draft_name** | **str** | The name of the draft that was used for this deploy. | [optional] +**cloud_storage_status** | **Enum** [ 'SYNCED', 'NOT_SYNCED', 'SYNC_FAILED' ] | Whether this deploy results file has been transferred to a customer storage location. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.deploy_response import DeployResponse + +deploy_response = DeployResponse( +job_id='07659d7d-2cce-47c0-9e49-185787ee565a', +status='COMPLETE', +type='CONFIG_DEPLOY_DRAFT', +message='Deploy creation message', +requester_name='requester.name', +file_exists=True, +created='2021-05-11T22:23:16Z', +modified='2021-05-11T22:23:16Z', +completed='2021-05-11T22:23:16Z', +draft_id='07659d7d-2cce-47c0-9e49-185787ee565a', +draft_name='Draft Name', +cloud_storage_status='SYNCED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Dimension.md b/docs/tools/sdk/python/Reference/V2024/Models/Dimension.md new file mode 100644 index 000000000..a19e50ec8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Dimension.md @@ -0,0 +1,76 @@ +--- +id: v2024-dimension +title: Dimension +pagination_label: Dimension +sidebar_label: Dimension +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Dimension', 'V2024Dimension'] +slug: /tools/sdk/python/v2024/models/dimension +tags: ['SDK', 'Software Development Kit', 'Dimension', 'V2024Dimension'] +--- + +# Dimension + +A Dimension + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The id of the Dimension. This field must be left null when creating a dimension, otherwise a 400 Bad Request error will result. | [optional] +**name** | **str** | The human-readable display name of the Dimension | [required] +**created** | **datetime** | Date the Dimension was created | [optional] [readonly] +**modified** | **datetime** | Date the Dimension was last modified. | [optional] [readonly] +**description** | **str** | A human-readable description of the Dimension | [optional] +**owner** | [**OwnerReference**](owner-reference) | | [required] +**access_profiles** | [**[]AccessProfileRef**](access-profile-ref) | | [optional] +**entitlements** | [**[]EntitlementRef**](entitlement-ref) | | [optional] +**membership** | [**DimensionMembershipSelector**](dimension-membership-selector) | | [optional] +**parent_id** | **str** | The ID of the parent role. This field can be left null when creating a dimension, but if provided, it must match the role ID specified in the path variable of the API call. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.dimension import Dimension + +dimension = Dimension( +id='2c918086749d78830174a1a40e121518', +name='Dimension 2567', +created='2021-03-01T22:32:58.104Z', +modified='2021-03-02T20:22:28.104Z', +description='Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.', +owner=sailpoint.v2024.models.owner_reference.OwnerReference( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'support', ), +access_profiles=[ + sailpoint.v2024.models.access_profile_ref.AccessProfileRef( + id = 'ff808081751e6e129f1518161919ecca', + type = 'ACCESS_PROFILE', + name = 'Access Profile 2567', ) + ], +entitlements=[ + sailpoint.v2024.models.entitlement_ref.EntitlementRef( + type = 'ENTITLEMENT', + id = '2c91809773dee32014e13e122092014e', + name = 'CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local', ) + ], +membership=sailpoint.v2024.models.dimension_membership_selector.DimensionMembershipSelector( + type = 'STANDARD', + criteria = sailpoint.v2024.models.dimension_criteria_level1.DimensionCriteriaLevel1( + operation = 'EQUALS', + key = sailpoint.v2024.models.dimension_criteria_key.DimensionCriteriaKey( + type = 'IDENTITY', + property = 'attribute.email', ), + string_value = 'carlee.cert1c9f9b6fd@mailinator.com', + children = [ + sailpoint.v2024.models.dimension_criteria_level2.DimensionCriteriaLevel2( + string_value = 'carlee.cert1c9f9b6fd@mailinator.com', ) + ], ), ), +parent_id='2c918086749d78830174a1a40e121518' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/DimensionBulkDeleteRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/DimensionBulkDeleteRequest.md new file mode 100644 index 000000000..d5326fafd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/DimensionBulkDeleteRequest.md @@ -0,0 +1,33 @@ +--- +id: v2024-dimension-bulk-delete-request +title: DimensionBulkDeleteRequest +pagination_label: DimensionBulkDeleteRequest +sidebar_label: DimensionBulkDeleteRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DimensionBulkDeleteRequest', 'V2024DimensionBulkDeleteRequest'] +slug: /tools/sdk/python/v2024/models/dimension-bulk-delete-request +tags: ['SDK', 'Software Development Kit', 'DimensionBulkDeleteRequest', 'V2024DimensionBulkDeleteRequest'] +--- + +# DimensionBulkDeleteRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**dimension_ids** | **[]str** | List of IDs of Dimensions to be deleted. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.dimension_bulk_delete_request import DimensionBulkDeleteRequest + +dimension_bulk_delete_request = DimensionBulkDeleteRequest( +dimension_ids=[2c9180847812e0b1017817051919ecca, 2c9180887812e0b201781e129f151816] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/DimensionCriteriaKey.md b/docs/tools/sdk/python/Reference/V2024/Models/DimensionCriteriaKey.md new file mode 100644 index 000000000..9b68f7cb0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/DimensionCriteriaKey.md @@ -0,0 +1,36 @@ +--- +id: v2024-dimension-criteria-key +title: DimensionCriteriaKey +pagination_label: DimensionCriteriaKey +sidebar_label: DimensionCriteriaKey +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DimensionCriteriaKey', 'V2024DimensionCriteriaKey'] +slug: /tools/sdk/python/v2024/models/dimension-criteria-key +tags: ['SDK', 'Software Development Kit', 'DimensionCriteriaKey', 'V2024DimensionCriteriaKey'] +--- + +# DimensionCriteriaKey + +Refers to a specific Identity attribute used in Dimension membership criteria. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**DimensionCriteriaKeyType**](dimension-criteria-key-type) | | [required] +**var_property** | **str** | The name of the identity attribute to which the associated criteria applies. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.dimension_criteria_key import DimensionCriteriaKey + +dimension_criteria_key = DimensionCriteriaKey( +type='IDENTITY', +var_property='attribute.email' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/DimensionCriteriaKeyType.md b/docs/tools/sdk/python/Reference/V2024/Models/DimensionCriteriaKeyType.md new file mode 100644 index 000000000..acacf6f66 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/DimensionCriteriaKeyType.md @@ -0,0 +1,21 @@ +--- +id: v2024-dimension-criteria-key-type +title: DimensionCriteriaKeyType +pagination_label: DimensionCriteriaKeyType +sidebar_label: DimensionCriteriaKeyType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DimensionCriteriaKeyType', 'V2024DimensionCriteriaKeyType'] +slug: /tools/sdk/python/v2024/models/dimension-criteria-key-type +tags: ['SDK', 'Software Development Kit', 'DimensionCriteriaKeyType', 'V2024DimensionCriteriaKeyType'] +--- + +# DimensionCriteriaKeyType + +Indicates whether the associated criteria represents an expression on identity attributes. + +## Enum + +* `IDENTITY` (value: `'IDENTITY'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/DimensionCriteriaLevel1.md b/docs/tools/sdk/python/Reference/V2024/Models/DimensionCriteriaLevel1.md new file mode 100644 index 000000000..9614fdbcf --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/DimensionCriteriaLevel1.md @@ -0,0 +1,49 @@ +--- +id: v2024-dimension-criteria-level1 +title: DimensionCriteriaLevel1 +pagination_label: DimensionCriteriaLevel1 +sidebar_label: DimensionCriteriaLevel1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DimensionCriteriaLevel1', 'V2024DimensionCriteriaLevel1'] +slug: /tools/sdk/python/v2024/models/dimension-criteria-level1 +tags: ['SDK', 'Software Development Kit', 'DimensionCriteriaLevel1', 'V2024DimensionCriteriaLevel1'] +--- + +# DimensionCriteriaLevel1 + +Defines STANDARD type Dimension membership + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | [**DimensionCriteriaOperation**](dimension-criteria-operation) | | [optional] +**key** | [**DimensionCriteriaKey**](dimension-criteria-key) | | [optional] +**string_value** | **str** | String value to test the Identity attribute specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is EQUALS, this field is required. Otherwise, specifying it is an error. | [optional] +**children** | [**[]DimensionCriteriaLevel2**](dimension-criteria-level2) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.dimension_criteria_level1 import DimensionCriteriaLevel1 + +dimension_criteria_level1 = DimensionCriteriaLevel1( +operation='EQUALS', +key=sailpoint.v2024.models.dimension_criteria_key.DimensionCriteriaKey( + type = 'IDENTITY', + property = 'attribute.email', ), +string_value='carlee.cert1c9f9b6fd@mailinator.com', +children=[ + sailpoint.v2024.models.dimension_criteria_level2.DimensionCriteriaLevel2( + operation = 'EQUALS', + key = sailpoint.v2024.models.dimension_criteria_key.DimensionCriteriaKey( + type = 'IDENTITY', + property = 'attribute.email', ), + string_value = 'carlee.cert1c9f9b6fd@mailinator.com', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/DimensionCriteriaLevel2.md b/docs/tools/sdk/python/Reference/V2024/Models/DimensionCriteriaLevel2.md new file mode 100644 index 000000000..19f062624 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/DimensionCriteriaLevel2.md @@ -0,0 +1,49 @@ +--- +id: v2024-dimension-criteria-level2 +title: DimensionCriteriaLevel2 +pagination_label: DimensionCriteriaLevel2 +sidebar_label: DimensionCriteriaLevel2 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DimensionCriteriaLevel2', 'V2024DimensionCriteriaLevel2'] +slug: /tools/sdk/python/v2024/models/dimension-criteria-level2 +tags: ['SDK', 'Software Development Kit', 'DimensionCriteriaLevel2', 'V2024DimensionCriteriaLevel2'] +--- + +# DimensionCriteriaLevel2 + +Defines STANDARD type Role membership + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | [**DimensionCriteriaOperation**](dimension-criteria-operation) | | [optional] +**key** | [**DimensionCriteriaKey**](dimension-criteria-key) | | [optional] +**string_value** | **str** | String value to test the Identity attribute specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, this field is required. Otherwise, specifying it is an error. | [optional] +**children** | [**[]DimensionCriteriaLevel3**](dimension-criteria-level3) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.dimension_criteria_level2 import DimensionCriteriaLevel2 + +dimension_criteria_level2 = DimensionCriteriaLevel2( +operation='EQUALS', +key=sailpoint.v2024.models.dimension_criteria_key.DimensionCriteriaKey( + type = 'IDENTITY', + property = 'attribute.email', ), +string_value='carlee.cert1c9f9b6fd@mailinator.com', +children=[ + sailpoint.v2024.models.dimension_criteria_level3.DimensionCriteriaLevel3( + operation = 'EQUALS', + key = sailpoint.v2024.models.dimension_criteria_key.DimensionCriteriaKey( + type = 'IDENTITY', + property = 'attribute.email', ), + string_value = 'carlee.cert1c9f9b6fd@mailinator.com', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/DimensionCriteriaLevel3.md b/docs/tools/sdk/python/Reference/V2024/Models/DimensionCriteriaLevel3.md new file mode 100644 index 000000000..7ad2f41ab --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/DimensionCriteriaLevel3.md @@ -0,0 +1,40 @@ +--- +id: v2024-dimension-criteria-level3 +title: DimensionCriteriaLevel3 +pagination_label: DimensionCriteriaLevel3 +sidebar_label: DimensionCriteriaLevel3 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DimensionCriteriaLevel3', 'V2024DimensionCriteriaLevel3'] +slug: /tools/sdk/python/v2024/models/dimension-criteria-level3 +tags: ['SDK', 'Software Development Kit', 'DimensionCriteriaLevel3', 'V2024DimensionCriteriaLevel3'] +--- + +# DimensionCriteriaLevel3 + +Defines STANDARD type Dimension membership + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | [**DimensionCriteriaOperation**](dimension-criteria-operation) | | [optional] +**key** | [**DimensionCriteriaKey**](dimension-criteria-key) | | [optional] +**string_value** | **str** | String value to test the Identity attribute specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, this field is required. Otherwise, specifying it is an error. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.dimension_criteria_level3 import DimensionCriteriaLevel3 + +dimension_criteria_level3 = DimensionCriteriaLevel3( +operation='EQUALS', +key=sailpoint.v2024.models.dimension_criteria_key.DimensionCriteriaKey( + type = 'IDENTITY', + property = 'attribute.email', ), +string_value='carlee.cert1c9f9b6fd@mailinator.com' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/DimensionCriteriaOperation.md b/docs/tools/sdk/python/Reference/V2024/Models/DimensionCriteriaOperation.md new file mode 100644 index 000000000..571c4b602 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/DimensionCriteriaOperation.md @@ -0,0 +1,25 @@ +--- +id: v2024-dimension-criteria-operation +title: DimensionCriteriaOperation +pagination_label: DimensionCriteriaOperation +sidebar_label: DimensionCriteriaOperation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DimensionCriteriaOperation', 'V2024DimensionCriteriaOperation'] +slug: /tools/sdk/python/v2024/models/dimension-criteria-operation +tags: ['SDK', 'Software Development Kit', 'DimensionCriteriaOperation', 'V2024DimensionCriteriaOperation'] +--- + +# DimensionCriteriaOperation + +An operation + +## Enum + +* `EQUALS` (value: `'EQUALS'`) + +* `AND` (value: `'AND'`) + +* `OR` (value: `'OR'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/DimensionMembershipSelector.md b/docs/tools/sdk/python/Reference/V2024/Models/DimensionMembershipSelector.md new file mode 100644 index 000000000..5171e6403 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/DimensionMembershipSelector.md @@ -0,0 +1,45 @@ +--- +id: v2024-dimension-membership-selector +title: DimensionMembershipSelector +pagination_label: DimensionMembershipSelector +sidebar_label: DimensionMembershipSelector +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DimensionMembershipSelector', 'V2024DimensionMembershipSelector'] +slug: /tools/sdk/python/v2024/models/dimension-membership-selector +tags: ['SDK', 'Software Development Kit', 'DimensionMembershipSelector', 'V2024DimensionMembershipSelector'] +--- + +# DimensionMembershipSelector + +When present, specifies that the Dimension is to be granted to Identities which either satisfy specific criteria. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**DimensionMembershipSelectorType**](dimension-membership-selector-type) | | [optional] +**criteria** | [**DimensionCriteriaLevel1**](dimension-criteria-level1) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.dimension_membership_selector import DimensionMembershipSelector + +dimension_membership_selector = DimensionMembershipSelector( +type='STANDARD', +criteria=sailpoint.v2024.models.dimension_criteria_level1.DimensionCriteriaLevel1( + operation = 'EQUALS', + key = sailpoint.v2024.models.dimension_criteria_key.DimensionCriteriaKey( + type = 'IDENTITY', + property = 'attribute.email', ), + string_value = 'carlee.cert1c9f9b6fd@mailinator.com', + children = [ + sailpoint.v2024.models.dimension_criteria_level2.DimensionCriteriaLevel2( + string_value = 'carlee.cert1c9f9b6fd@mailinator.com', ) + ], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/DimensionMembershipSelectorType.md b/docs/tools/sdk/python/Reference/V2024/Models/DimensionMembershipSelectorType.md new file mode 100644 index 000000000..0ef7edc21 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/DimensionMembershipSelectorType.md @@ -0,0 +1,21 @@ +--- +id: v2024-dimension-membership-selector-type +title: DimensionMembershipSelectorType +pagination_label: DimensionMembershipSelectorType +sidebar_label: DimensionMembershipSelectorType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DimensionMembershipSelectorType', 'V2024DimensionMembershipSelectorType'] +slug: /tools/sdk/python/v2024/models/dimension-membership-selector-type +tags: ['SDK', 'Software Development Kit', 'DimensionMembershipSelectorType', 'V2024DimensionMembershipSelectorType'] +--- + +# DimensionMembershipSelectorType + +This enum characterizes the type of a Dimension's membership selector. Only the STANDARD type supported: STANDARD: Indicates that Dimension membership is defined in terms of a criteria expression + +## Enum + +* `STANDARD` (value: `'STANDARD'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/DimensionRef.md b/docs/tools/sdk/python/Reference/V2024/Models/DimensionRef.md new file mode 100644 index 000000000..fd9692cf0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/DimensionRef.md @@ -0,0 +1,37 @@ +--- +id: v2024-dimension-ref +title: DimensionRef +pagination_label: DimensionRef +sidebar_label: DimensionRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DimensionRef', 'V2024DimensionRef'] +slug: /tools/sdk/python/v2024/models/dimension-ref +tags: ['SDK', 'Software Development Kit', 'DimensionRef', 'V2024DimensionRef'] +--- + +# DimensionRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'DIMENSION' ] | The type of the object to which this reference applies | [optional] +**id** | **str** | ID of the object to which this reference applies | [optional] +**name** | **str** | Human-readable display name of the object to which this reference applies | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.dimension_ref import DimensionRef + +dimension_ref = DimensionRef( +type='DIMENSION', +id='2c91808568c529c60168cca6f90c1313', +name='Role 2' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/DisplayReference.md b/docs/tools/sdk/python/Reference/V2024/Models/DisplayReference.md new file mode 100644 index 000000000..da8704de6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/DisplayReference.md @@ -0,0 +1,37 @@ +--- +id: v2024-display-reference +title: DisplayReference +pagination_label: DisplayReference +sidebar_label: DisplayReference +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DisplayReference', 'V2024DisplayReference'] +slug: /tools/sdk/python/v2024/models/display-reference +tags: ['SDK', 'Software Development Kit', 'DisplayReference', 'V2024DisplayReference'] +--- + +# DisplayReference + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the referenced object. | [optional] +**name** | **str** | The human readable name of the referenced object. | [optional] +**display_name** | **str** | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.display_reference import DisplayReference + +display_reference = DisplayReference( +id='2c91808568c529c60168cca6f90c1313', +name='John Doe', +display_name='John Q. Doe' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/DkimAttributes.md b/docs/tools/sdk/python/Reference/V2024/Models/DkimAttributes.md new file mode 100644 index 000000000..eb39d15fc --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/DkimAttributes.md @@ -0,0 +1,42 @@ +--- +id: v2024-dkim-attributes +title: DkimAttributes +pagination_label: DkimAttributes +sidebar_label: DkimAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DkimAttributes', 'V2024DkimAttributes'] +slug: /tools/sdk/python/v2024/models/dkim-attributes +tags: ['SDK', 'Software Development Kit', 'DkimAttributes', 'V2024DkimAttributes'] +--- + +# DkimAttributes + +DKIM attributes for a domain or identity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | UUID associated with domain to be verified | [optional] +**address** | **str** | The identity or domain address | [optional] +**dkim_enabled** | **bool** | Whether or not DKIM has been enabled for this domain / identity | [optional] [default to False] +**dkim_tokens** | **[]str** | The tokens to be added to a DNS for verification | [optional] +**dkim_verification_status** | **str** | The current status if the domain /identity has been verified. Ie Success, Failed, Pending | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.dkim_attributes import DkimAttributes + +dkim_attributes = DkimAttributes( +id='123b45b0-aaaa-bbbb-a7db-123456a56abc', +address='BobSmith@sailpoint.com', +dkim_enabled=True, +dkim_tokens=[uq1m3jjk25ckd3whl4n7y46c56r5l6aq, u7pm38jky9ckdawhlsn7y4dcj6f5lpgq, uhpm3jjkjjckdkwhlqn7yw6cjer5tpay], +dkim_verification_status='Success' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/DomainAddress.md b/docs/tools/sdk/python/Reference/V2024/Models/DomainAddress.md new file mode 100644 index 000000000..d07324154 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/DomainAddress.md @@ -0,0 +1,33 @@ +--- +id: v2024-domain-address +title: DomainAddress +pagination_label: DomainAddress +sidebar_label: DomainAddress +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DomainAddress', 'V2024DomainAddress'] +slug: /tools/sdk/python/v2024/models/domain-address +tags: ['SDK', 'Software Development Kit', 'DomainAddress', 'V2024DomainAddress'] +--- + +# DomainAddress + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**domain** | **str** | A domain address | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.domain_address import DomainAddress + +domain_address = DomainAddress( +domain='sailpoint.com' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/DomainStatusDto.md b/docs/tools/sdk/python/Reference/V2024/Models/DomainStatusDto.md new file mode 100644 index 000000000..b8416095b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/DomainStatusDto.md @@ -0,0 +1,42 @@ +--- +id: v2024-domain-status-dto +title: DomainStatusDto +pagination_label: DomainStatusDto +sidebar_label: DomainStatusDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DomainStatusDto', 'V2024DomainStatusDto'] +slug: /tools/sdk/python/v2024/models/domain-status-dto +tags: ['SDK', 'Software Development Kit', 'DomainStatusDto', 'V2024DomainStatusDto'] +--- + +# DomainStatusDto + +Domain status DTO containing everything required to verify via DKIM + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | New UUID associated with domain to be verified | [optional] +**domain** | **str** | A domain address | [optional] +**dkim_enabled** | **object** | DKIM is enabled for this domain | [optional] +**dkim_tokens** | **[]str** | DKIM tokens required for authentication | [optional] +**dkim_verification_status** | **str** | Status of DKIM authentication | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.domain_status_dto import DomainStatusDto + +domain_status_dto = DomainStatusDto( +id='123b45b0-aaaa-bbbb-a7db-123456a56abc', +domain='sailpoint.com', +dkim_enabled=true, +dkim_tokens=[token1, token2, token3], +dkim_verification_status='PENDING' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/DraftResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/DraftResponse.md new file mode 100644 index 000000000..12edc100b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/DraftResponse.md @@ -0,0 +1,70 @@ +--- +id: v2024-draft-response +title: DraftResponse +pagination_label: DraftResponse +sidebar_label: DraftResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DraftResponse', 'V2024DraftResponse'] +slug: /tools/sdk/python/v2024/models/draft-response +tags: ['SDK', 'Software Development Kit', 'DraftResponse', 'V2024DraftResponse'] +--- + +# DraftResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**job_id** | **str** | Unique id assigned to this job. | [optional] +**status** | **Enum** [ 'NOT_STARTED', 'IN_PROGRESS', 'COMPLETE', 'CANCELLED', 'FAILED' ] | Status of the job. | [optional] +**type** | **Enum** [ 'CREATE_DRAFT' ] | Type of the job, will always be CREATE_DRAFT for this type of job. | [optional] +**message** | **str** | Message providing information about the outcome of the draft process. | [optional] +**requester_name** | **str** | The name of user that that initiated the draft process. | [optional] +**file_exists** | **bool** | Whether or not a file was generated for this draft. | [optional] [default to True] +**created** | **datetime** | The time the job was started. | [optional] +**modified** | **datetime** | The time of the last update to the job. | [optional] +**completed** | **datetime** | The time the job was completed. | [optional] +**name** | **str** | Name of the draft. | [optional] +**source_tenant** | **str** | Tenant owner of the backup from which the draft was generated. | [optional] +**source_backup_id** | **str** | Id of the backup from which the draft was generated. | [optional] +**source_backup_name** | **str** | Name of the backup from which the draft was generated. | [optional] +**mode** | **Enum** [ 'RESTORE', 'PROMOTE', 'UPLOAD' ] | Denotes the origin of the source backup from which the draft was generated. - RESTORE - Same tenant. - PROMOTE - Different tenant. - UPLOAD - Uploaded configuration. | [optional] +**approval_status** | **Enum** [ 'DEFAULT', 'PENDING_APPROVAL', 'APPROVED', 'DENIED' ] | Approval status of the draft used to determine whether or not the draft can be deployed. | [optional] +**approval_comment** | [**[]ApprovalComment**](approval-comment) | List of comments that have been exchanged between an approval requester and an approver. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.draft_response import DraftResponse + +draft_response = DraftResponse( +job_id='07659d7d-2cce-47c0-9e49-185787ee565a', +status='COMPLETE', +type='CREATE_DRAFT', +message='Draft creation message', +requester_name='requester.name', +file_exists=True, +created='2021-05-11T22:23:16Z', +modified='2021-05-11T22:23:16Z', +completed='2021-05-11T22:23:16Z', +name='Draft name', +source_tenant='source-tenant', +source_backup_id='549bf881-1ac4-4a64-9acf-6014e8a3a887', +source_backup_name='Source backup name', +mode='RESTORE', +approval_status='APPROVED', +approval_comment=[ + sailpoint.v2024.models.approval_comment.Approval Comment( + comment = 'Approval comment', + timestamp = '2021-05-11T22:23:16Z', + user = 'user.name', + id = '549bf881-1ac4-4a64-9acf-6014e8a3a887', + changed_to_status = 'PENDING_APPROVAL', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/DtoType.md b/docs/tools/sdk/python/Reference/V2024/Models/DtoType.md new file mode 100644 index 000000000..80bce7ac3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/DtoType.md @@ -0,0 +1,77 @@ +--- +id: v2024-dto-type +title: DtoType +pagination_label: DtoType +sidebar_label: DtoType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DtoType', 'V2024DtoType'] +slug: /tools/sdk/python/v2024/models/dto-type +tags: ['SDK', 'Software Development Kit', 'DtoType', 'V2024DtoType'] +--- + +# DtoType + +An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + +## Enum + +* `ACCOUNT_CORRELATION_CONFIG` (value: `'ACCOUNT_CORRELATION_CONFIG'`) + +* `ACCESS_PROFILE` (value: `'ACCESS_PROFILE'`) + +* `ACCESS_REQUEST_APPROVAL` (value: `'ACCESS_REQUEST_APPROVAL'`) + +* `ACCOUNT` (value: `'ACCOUNT'`) + +* `APPLICATION` (value: `'APPLICATION'`) + +* `CAMPAIGN` (value: `'CAMPAIGN'`) + +* `CAMPAIGN_FILTER` (value: `'CAMPAIGN_FILTER'`) + +* `CERTIFICATION` (value: `'CERTIFICATION'`) + +* `CLUSTER` (value: `'CLUSTER'`) + +* `CONNECTOR_SCHEMA` (value: `'CONNECTOR_SCHEMA'`) + +* `ENTITLEMENT` (value: `'ENTITLEMENT'`) + +* `GOVERNANCE_GROUP` (value: `'GOVERNANCE_GROUP'`) + +* `IDENTITY` (value: `'IDENTITY'`) + +* `IDENTITY_PROFILE` (value: `'IDENTITY_PROFILE'`) + +* `IDENTITY_REQUEST` (value: `'IDENTITY_REQUEST'`) + +* `MACHINE_IDENTITY` (value: `'MACHINE_IDENTITY'`) + +* `LIFECYCLE_STATE` (value: `'LIFECYCLE_STATE'`) + +* `PASSWORD_POLICY` (value: `'PASSWORD_POLICY'`) + +* `ROLE` (value: `'ROLE'`) + +* `RULE` (value: `'RULE'`) + +* `SOD_POLICY` (value: `'SOD_POLICY'`) + +* `SOURCE` (value: `'SOURCE'`) + +* `TAG` (value: `'TAG'`) + +* `TAG_CATEGORY` (value: `'TAG_CATEGORY'`) + +* `TASK_RESULT` (value: `'TASK_RESULT'`) + +* `REPORT_RESULT` (value: `'REPORT_RESULT'`) + +* `SOD_VIOLATION` (value: `'SOD_VIOLATION'`) + +* `ACCOUNT_ACTIVITY` (value: `'ACCOUNT_ACTIVITY'`) + +* `WORKGROUP` (value: `'WORKGROUP'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/EmailNotificationOption.md b/docs/tools/sdk/python/Reference/V2024/Models/EmailNotificationOption.md new file mode 100644 index 000000000..71a6b6dd5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/EmailNotificationOption.md @@ -0,0 +1,40 @@ +--- +id: v2024-email-notification-option +title: EmailNotificationOption +pagination_label: EmailNotificationOption +sidebar_label: EmailNotificationOption +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EmailNotificationOption', 'V2024EmailNotificationOption'] +slug: /tools/sdk/python/v2024/models/email-notification-option +tags: ['SDK', 'Software Development Kit', 'EmailNotificationOption', 'V2024EmailNotificationOption'] +--- + +# EmailNotificationOption + +This is used for representing email configuration for a lifecycle state + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**notify_managers** | **bool** | If true, then the manager is notified of the lifecycle state change. | [optional] [default to False] +**notify_all_admins** | **bool** | If true, then all the admins are notified of the lifecycle state change. | [optional] [default to False] +**notify_specific_users** | **bool** | If true, then the users specified in \"emailAddressList\" below are notified of lifecycle state change. | [optional] [default to False] +**email_address_list** | **[]str** | List of user email addresses. If \"notifySpecificUsers\" option is true, then these users are notified of lifecycle state change. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.email_notification_option import EmailNotificationOption + +email_notification_option = EmailNotificationOption( +notify_managers=True, +notify_all_admins=True, +notify_specific_users=True, +email_address_list=[test@test.com, test2@test.com] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/EmailStatusDto.md b/docs/tools/sdk/python/Reference/V2024/Models/EmailStatusDto.md new file mode 100644 index 000000000..affac6b63 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/EmailStatusDto.md @@ -0,0 +1,39 @@ +--- +id: v2024-email-status-dto +title: EmailStatusDto +pagination_label: EmailStatusDto +sidebar_label: EmailStatusDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EmailStatusDto', 'V2024EmailStatusDto'] +slug: /tools/sdk/python/v2024/models/email-status-dto +tags: ['SDK', 'Software Development Kit', 'EmailStatusDto', 'V2024EmailStatusDto'] +--- + +# EmailStatusDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] +**email** | **str** | | [optional] +**is_verified_by_domain** | **bool** | | [optional] +**verification_status** | **Enum** [ 'PENDING', 'SUCCESS', 'FAILED' ] | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.email_status_dto import EmailStatusDto + +email_status_dto = EmailStatusDto( +id='', +email='sender@example.com', +is_verified_by_domain=False, +verification_status='PENDING' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Entitlement.md b/docs/tools/sdk/python/Reference/V2024/Models/Entitlement.md new file mode 100644 index 000000000..adb87690e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Entitlement.md @@ -0,0 +1,97 @@ +--- +id: v2024-entitlement +title: Entitlement +pagination_label: Entitlement +sidebar_label: Entitlement +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Entitlement', 'V2024Entitlement'] +slug: /tools/sdk/python/v2024/models/entitlement +tags: ['SDK', 'Software Development Kit', 'Entitlement', 'V2024Entitlement'] +--- + +# Entitlement + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The entitlement id | [optional] +**name** | **str** | The entitlement name | [optional] +**attribute** | **str** | The entitlement attribute name | [optional] +**value** | **str** | The value of the entitlement | [optional] +**source_schema_object_type** | **str** | The object type of the entitlement from the source schema | [optional] +**description** | **str** | The description of the entitlement | [optional] +**privileged** | **bool** | True if the entitlement is privileged | [optional] +**cloud_governed** | **bool** | True if the entitlement is cloud governed | [optional] +**requestable** | **bool** | True if the entitlement is able to be directly requested | [optional] [default to False] +**owner** | [**EntitlementOwner**](entitlement-owner) | | [optional] +**manually_updated_fields** | **map[string]object** | A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated. | [optional] +**access_model_metadata** | [**EntitlementAccessModelMetadata**](entitlement-access-model-metadata) | | [optional] +**created** | **datetime** | Time when the entitlement was created | [optional] +**modified** | **datetime** | Time when the entitlement was last modified | [optional] +**source** | [**EntitlementSource**](entitlement-source) | | [optional] +**attributes** | **map[string]object** | A map of free-form key-value pairs from the source system | [optional] +**segments** | **[]str** | List of IDs of segments, if any, to which this Entitlement is assigned. | [optional] +**direct_permissions** | [**[]PermissionDto**](permission-dto) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.entitlement import Entitlement + +entitlement = Entitlement( +id='2c91808874ff91550175097daaec161c', +name='LauncherTest2', +attribute='memberOf', +value='CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local', +source_schema_object_type='group', +description='CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local', +privileged=True, +cloud_governed=True, +requestable=True, +owner=sailpoint.v2024.models.entitlement_owner.Entitlement_owner( + id = '2c9180827ca885d7017ca8ce28a000eb', + type = 'IDENTITY', + name = 'john.doe', ), +manually_updated_fields={DISPLAY_NAME=true, DESCRIPTION=true}, +access_model_metadata=sailpoint.v2024.models.entitlement_access_model_metadata.Entitlement_accessModelMetadata( + attributes = [ + sailpoint.v2024.models.access_model_metadata.AccessModelMetadata( + key = 'iscCsp', + name = 'CSP', + multiselect = True, + status = 'active', + type = 'governance', + object_types = [ + 'general' + ], + description = 'Indicates the type of deployment environment of an access item.', + values = [ + sailpoint.v2024.models.access_model_metadata_values_inner.AccessModelMetadata_values_inner( + value = 'development', + name = 'Development', + status = 'active', ) + ], ) + ], ), +created='2020-10-08T18:33:52.029Z', +modified='2020-10-08T18:33:52.029Z', +source=sailpoint.v2024.models.entitlement_source.Entitlement_source( + id = '2c9180827ca885d7017ca8ce28a000eb', + type = 'SOURCE', + name = 'ODS-AD-Source', ), +attributes={fieldName=fieldValue}, +segments=[f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a], +direct_permissions=[ + sailpoint.v2024.models.permission_dto.PermissionDto( + rights = [ + 'SELECT' + ], + target = 'SYS.GV_$TRANSACTION', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/EntitlementAccessModelMetadata.md b/docs/tools/sdk/python/Reference/V2024/Models/EntitlementAccessModelMetadata.md new file mode 100644 index 000000000..2e7c3747f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/EntitlementAccessModelMetadata.md @@ -0,0 +1,51 @@ +--- +id: v2024-entitlement-access-model-metadata +title: EntitlementAccessModelMetadata +pagination_label: EntitlementAccessModelMetadata +sidebar_label: EntitlementAccessModelMetadata +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementAccessModelMetadata', 'V2024EntitlementAccessModelMetadata'] +slug: /tools/sdk/python/v2024/models/entitlement-access-model-metadata +tags: ['SDK', 'Software Development Kit', 'EntitlementAccessModelMetadata', 'V2024EntitlementAccessModelMetadata'] +--- + +# EntitlementAccessModelMetadata + +Additional data to classify the entitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**[]AccessModelMetadata**](access-model-metadata) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.entitlement_access_model_metadata import EntitlementAccessModelMetadata + +entitlement_access_model_metadata = EntitlementAccessModelMetadata( +attributes=[ + sailpoint.v2024.models.access_model_metadata.AccessModelMetadata( + key = 'iscCsp', + name = 'CSP', + multiselect = True, + status = 'active', + type = 'governance', + object_types = [ + 'general' + ], + description = 'Indicates the type of deployment environment of an access item.', + values = [ + sailpoint.v2024.models.access_model_metadata_values_inner.AccessModelMetadata_values_inner( + value = 'development', + name = 'Development', + status = 'active', ) + ], ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/EntitlementAccessRequestConfig.md b/docs/tools/sdk/python/Reference/V2024/Models/EntitlementAccessRequestConfig.md new file mode 100644 index 000000000..f63da7128 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/EntitlementAccessRequestConfig.md @@ -0,0 +1,41 @@ +--- +id: v2024-entitlement-access-request-config +title: EntitlementAccessRequestConfig +pagination_label: EntitlementAccessRequestConfig +sidebar_label: EntitlementAccessRequestConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementAccessRequestConfig', 'V2024EntitlementAccessRequestConfig'] +slug: /tools/sdk/python/v2024/models/entitlement-access-request-config +tags: ['SDK', 'Software Development Kit', 'EntitlementAccessRequestConfig', 'V2024EntitlementAccessRequestConfig'] +--- + +# EntitlementAccessRequestConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approval_schemes** | [**[]EntitlementApprovalScheme**](entitlement-approval-scheme) | Ordered list of approval steps for the access request. Empty when no approval is required. | [optional] +**request_comment_required** | **bool** | If the requester must provide a comment during access request. | [optional] [default to False] +**denial_comment_required** | **bool** | If the reviewer must provide a comment when denying the access request. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.entitlement_access_request_config import EntitlementAccessRequestConfig + +entitlement_access_request_config = EntitlementAccessRequestConfig( +approval_schemes=[ + sailpoint.v2024.models.entitlement_approval_scheme.EntitlementApprovalScheme( + approver_type = 'GOVERNANCE_GROUP', + approver_id = 'e3eab852-8315-467f-9de7-70eda97f63c8', ) + ], +request_comment_required=True, +denial_comment_required=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/EntitlementApprovalScheme.md b/docs/tools/sdk/python/Reference/V2024/Models/EntitlementApprovalScheme.md new file mode 100644 index 000000000..9343d7882 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/EntitlementApprovalScheme.md @@ -0,0 +1,35 @@ +--- +id: v2024-entitlement-approval-scheme +title: EntitlementApprovalScheme +pagination_label: EntitlementApprovalScheme +sidebar_label: EntitlementApprovalScheme +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementApprovalScheme', 'V2024EntitlementApprovalScheme'] +slug: /tools/sdk/python/v2024/models/entitlement-approval-scheme +tags: ['SDK', 'Software Development Kit', 'EntitlementApprovalScheme', 'V2024EntitlementApprovalScheme'] +--- + +# EntitlementApprovalScheme + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approver_type** | **Enum** [ 'ENTITLEMENT_OWNER', 'SOURCE_OWNER', 'MANAGER', 'GOVERNANCE_GROUP' ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **ENTITLEMENT_OWNER**: Owner of the associated Entitlement **SOURCE_OWNER**: Owner of the associated Source **MANAGER**: Manager of the Identity for whom the request is being made **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] +**approver_id** | **str** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.entitlement_approval_scheme import EntitlementApprovalScheme + +entitlement_approval_scheme = EntitlementApprovalScheme( +approver_type='GOVERNANCE_GROUP', +approver_id='e3eab852-8315-467f-9de7-70eda97f63c8' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/EntitlementBulkUpdateRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/EntitlementBulkUpdateRequest.md new file mode 100644 index 000000000..fc4b6e52f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/EntitlementBulkUpdateRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-entitlement-bulk-update-request +title: EntitlementBulkUpdateRequest +pagination_label: EntitlementBulkUpdateRequest +sidebar_label: EntitlementBulkUpdateRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementBulkUpdateRequest', 'V2024EntitlementBulkUpdateRequest'] +slug: /tools/sdk/python/v2024/models/entitlement-bulk-update-request +tags: ['SDK', 'Software Development Kit', 'EntitlementBulkUpdateRequest', 'V2024EntitlementBulkUpdateRequest'] +--- + +# EntitlementBulkUpdateRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entitlement_ids** | **[]str** | List of entitlement ids to update | [required] +**json_patch** | [**[]JsonPatchOperation**](json-patch-operation) | | [required] +} + +## Example + +```python +from sailpoint.v2024.models.entitlement_bulk_update_request import EntitlementBulkUpdateRequest + +entitlement_bulk_update_request = EntitlementBulkUpdateRequest( +entitlement_ids=[2c91808a7624751a01762f19d665220d, 2c91808a7624751a01762f19d67c220e, 2c91808a7624751a01762f19d692220f], +json_patch=[{op=replace, path=/privileged, value=false}, {op=replace, path=/requestable, value=false}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/EntitlementDocument.md b/docs/tools/sdk/python/Reference/V2024/Models/EntitlementDocument.md new file mode 100644 index 000000000..1bec6f5a9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/EntitlementDocument.md @@ -0,0 +1,95 @@ +--- +id: v2024-entitlement-document +title: EntitlementDocument +pagination_label: EntitlementDocument +sidebar_label: EntitlementDocument +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementDocument', 'V2024EntitlementDocument'] +slug: /tools/sdk/python/v2024/models/entitlement-document +tags: ['SDK', 'Software Development Kit', 'EntitlementDocument', 'V2024EntitlementDocument'] +--- + +# EntitlementDocument + +Entitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the referenced object. | [required] +**name** | **str** | The human readable name of the referenced object. | [required] +**modified** | **datetime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional] +**synced** | **str** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**display_name** | **str** | Entitlement's display name. | [optional] +**source** | [**EntitlementDocumentAllOfSource**](entitlement-document-all-of-source) | | [optional] +**segments** | [**[]BaseSegment**](base-segment) | Segments with the entitlement. | [optional] +**segment_count** | **int** | Number of segments with the role. | [optional] +**requestable** | **bool** | Indicates whether the entitlement is requestable. | [optional] [default to False] +**cloud_governed** | **bool** | Indicates whether the entitlement is cloud governed. | [optional] [default to False] +**created** | **datetime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**privileged** | **bool** | Indicates whether the entitlement is privileged. | [optional] [default to False] +**tags** | **[]str** | Tags that have been applied to the object. | [optional] +**attribute** | **str** | Attribute information for the entitlement. | [optional] +**value** | **str** | Value of the entitlement. | [optional] +**source_schema_object_type** | **str** | Source schema object type of the entitlement. | [optional] +**var_schema** | **str** | Schema type of the entitlement. | [optional] +**hash** | **str** | Read-only calculated hash value of an entitlement. | [optional] +**attributes** | **map[string]object** | Attributes of the entitlement. | [optional] +**truncated_attributes** | **[]str** | Truncated attributes of the entitlement. | [optional] +**contains_data_access** | **bool** | Indicates whether the entitlement contains data access. | [optional] [default to False] +**manually_updated_fields** | [**EntitlementDocumentAllOfManuallyUpdatedFields**](entitlement-document-all-of-manually-updated-fields) | | [optional] +**permissions** | [**[]EntitlementDocumentAllOfPermissions**](entitlement-document-all-of-permissions) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.entitlement_document import EntitlementDocument + +entitlement_document = EntitlementDocument( +id='2c91808375d8e80a0175e1f88a575222', +name='john.doe', +modified='2018-06-25T20:22:28.104Z', +synced='', +display_name='Admin', +source=sailpoint.v2024.models.entitlement_document_all_of_source.EntitlementDocument_allOf_source( + id = '2c91808b6e9e6fb8016eec1a2b6f7b5f', + name = 'ODS-HR-Employees', + type = 'SOURCE', ), +segments=[ + sailpoint.v2024.models.base_segment.BaseSegment( + id = 'b009b6e3-b56d-41d9-8735-cb532ea0b017', + name = 'Test Segment', ) + ], +segment_count=1, +requestable=False, +cloud_governed=False, +created='2018-06-25T20:22:28.104Z', +privileged=False, +tags=[TAG_1, TAG_2], +attribute='groups', +value='1733ff75-441e-4327-9bfc-3ac445fd8cd1', +source_schema_object_type='group', +var_schema='group', +hash='c6fab95235584cca98a454a2f51e5683bc77d6a0', +attributes={ }, +truncated_attributes=[ + '' + ], +contains_data_access=True, +manually_updated_fields=sailpoint.v2024.models.entitlement_document_all_of_manually_updated_fields.EntitlementDocument_allOf_manuallyUpdatedFields( + description = False, + display_name = False, ), +permissions=[ + sailpoint.v2024.models.entitlement_document_all_of_permissions.EntitlementDocument_allOf_permissions( + target = 'SYS.GV_$TRANSACTION', + rights = [ + 'SELECT' + ], ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/EntitlementDocumentAllOfManuallyUpdatedFields.md b/docs/tools/sdk/python/Reference/V2024/Models/EntitlementDocumentAllOfManuallyUpdatedFields.md new file mode 100644 index 000000000..43597456e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/EntitlementDocumentAllOfManuallyUpdatedFields.md @@ -0,0 +1,36 @@ +--- +id: v2024-entitlement-document-all-of-manually-updated-fields +title: EntitlementDocumentAllOfManuallyUpdatedFields +pagination_label: EntitlementDocumentAllOfManuallyUpdatedFields +sidebar_label: EntitlementDocumentAllOfManuallyUpdatedFields +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementDocumentAllOfManuallyUpdatedFields', 'V2024EntitlementDocumentAllOfManuallyUpdatedFields'] +slug: /tools/sdk/python/v2024/models/entitlement-document-all-of-manually-updated-fields +tags: ['SDK', 'Software Development Kit', 'EntitlementDocumentAllOfManuallyUpdatedFields', 'V2024EntitlementDocumentAllOfManuallyUpdatedFields'] +--- + +# EntitlementDocumentAllOfManuallyUpdatedFields + +Indicates whether the entitlement's display name and/or description have been manually updated. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **bool** | | [optional] [default to False] +**display_name** | **bool** | | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.entitlement_document_all_of_manually_updated_fields import EntitlementDocumentAllOfManuallyUpdatedFields + +entitlement_document_all_of_manually_updated_fields = EntitlementDocumentAllOfManuallyUpdatedFields( +description=False, +display_name=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/EntitlementDocumentAllOfPermissions.md b/docs/tools/sdk/python/Reference/V2024/Models/EntitlementDocumentAllOfPermissions.md new file mode 100644 index 000000000..85ab639ab --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/EntitlementDocumentAllOfPermissions.md @@ -0,0 +1,37 @@ +--- +id: v2024-entitlement-document-all-of-permissions +title: EntitlementDocumentAllOfPermissions +pagination_label: EntitlementDocumentAllOfPermissions +sidebar_label: EntitlementDocumentAllOfPermissions +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementDocumentAllOfPermissions', 'V2024EntitlementDocumentAllOfPermissions'] +slug: /tools/sdk/python/v2024/models/entitlement-document-all-of-permissions +tags: ['SDK', 'Software Development Kit', 'EntitlementDocumentAllOfPermissions', 'V2024EntitlementDocumentAllOfPermissions'] +--- + +# EntitlementDocumentAllOfPermissions + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**target** | **str** | The target the permission would grants rights on. | [optional] +**rights** | **[]str** | All the rights (e.g. actions) that this permission allows on the target | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.entitlement_document_all_of_permissions import EntitlementDocumentAllOfPermissions + +entitlement_document_all_of_permissions = EntitlementDocumentAllOfPermissions( +target='SYS.GV_$TRANSACTION', +rights=[ + 'SELECT' + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/EntitlementDocumentAllOfSource.md b/docs/tools/sdk/python/Reference/V2024/Models/EntitlementDocumentAllOfSource.md new file mode 100644 index 000000000..1906d0a96 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/EntitlementDocumentAllOfSource.md @@ -0,0 +1,38 @@ +--- +id: v2024-entitlement-document-all-of-source +title: EntitlementDocumentAllOfSource +pagination_label: EntitlementDocumentAllOfSource +sidebar_label: EntitlementDocumentAllOfSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementDocumentAllOfSource', 'V2024EntitlementDocumentAllOfSource'] +slug: /tools/sdk/python/v2024/models/entitlement-document-all-of-source +tags: ['SDK', 'Software Development Kit', 'EntitlementDocumentAllOfSource', 'V2024EntitlementDocumentAllOfSource'] +--- + +# EntitlementDocumentAllOfSource + +Entitlement's source. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of entitlement's source. | [optional] +**name** | **str** | Display name of entitlement's source. | [optional] +**type** | **str** | Type of object. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.entitlement_document_all_of_source import EntitlementDocumentAllOfSource + +entitlement_document_all_of_source = EntitlementDocumentAllOfSource( +id='2c91808b6e9e6fb8016eec1a2b6f7b5f', +name='ODS-HR-Employees', +type='SOURCE' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/EntitlementOwner.md b/docs/tools/sdk/python/Reference/V2024/Models/EntitlementOwner.md new file mode 100644 index 000000000..c1234865d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/EntitlementOwner.md @@ -0,0 +1,38 @@ +--- +id: v2024-entitlement-owner +title: EntitlementOwner +pagination_label: EntitlementOwner +sidebar_label: EntitlementOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementOwner', 'V2024EntitlementOwner'] +slug: /tools/sdk/python/v2024/models/entitlement-owner +tags: ['SDK', 'Software Development Kit', 'EntitlementOwner', 'V2024EntitlementOwner'] +--- + +# EntitlementOwner + +The identity that owns the entitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The identity ID | [optional] +**type** | **Enum** [ 'IDENTITY' ] | The type of object | [optional] +**name** | **str** | The display name of the identity | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.entitlement_owner import EntitlementOwner + +entitlement_owner = EntitlementOwner( +id='2c9180827ca885d7017ca8ce28a000eb', +type='IDENTITY', +name='john.doe' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/EntitlementRef.md b/docs/tools/sdk/python/Reference/V2024/Models/EntitlementRef.md new file mode 100644 index 000000000..49f708a22 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/EntitlementRef.md @@ -0,0 +1,38 @@ +--- +id: v2024-entitlement-ref +title: EntitlementRef +pagination_label: EntitlementRef +sidebar_label: EntitlementRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementRef', 'V2024EntitlementRef'] +slug: /tools/sdk/python/v2024/models/entitlement-ref +tags: ['SDK', 'Software Development Kit', 'EntitlementRef', 'V2024EntitlementRef'] +--- + +# EntitlementRef + +Entitlement including a specific set of access. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ENTITLEMENT' ] | Entitlement's DTO type. | [optional] +**id** | **str** | Entitlement's ID. | [optional] +**name** | **str** | Entitlement's display name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.entitlement_ref import EntitlementRef + +entitlement_ref = EntitlementRef( +type='ENTITLEMENT', +id='2c91809773dee32014e13e122092014e', +name='CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/EntitlementRef1.md b/docs/tools/sdk/python/Reference/V2024/Models/EntitlementRef1.md new file mode 100644 index 000000000..886dc77b8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/EntitlementRef1.md @@ -0,0 +1,38 @@ +--- +id: v2024-entitlement-ref1 +title: EntitlementRef1 +pagination_label: EntitlementRef1 +sidebar_label: EntitlementRef1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementRef1', 'V2024EntitlementRef1'] +slug: /tools/sdk/python/v2024/models/entitlement-ref1 +tags: ['SDK', 'Software Development Kit', 'EntitlementRef1', 'V2024EntitlementRef1'] +--- + +# EntitlementRef1 + +Entitlement including a specific set of access. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ENTITLEMENT' ] | Entitlement's DTO type. | [optional] +**id** | **str** | Entitlement's ID. | [optional] +**name** | **str** | Entitlement's display name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.entitlement_ref1 import EntitlementRef1 + +entitlement_ref1 = EntitlementRef1( +type='ENTITLEMENT', +id='2c91809773dee32014e13e122092014e', +name='CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/EntitlementRequestConfig.md b/docs/tools/sdk/python/Reference/V2024/Models/EntitlementRequestConfig.md new file mode 100644 index 000000000..caf51c11b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/EntitlementRequestConfig.md @@ -0,0 +1,39 @@ +--- +id: v2024-entitlement-request-config +title: EntitlementRequestConfig +pagination_label: EntitlementRequestConfig +sidebar_label: EntitlementRequestConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementRequestConfig', 'V2024EntitlementRequestConfig'] +slug: /tools/sdk/python/v2024/models/entitlement-request-config +tags: ['SDK', 'Software Development Kit', 'EntitlementRequestConfig', 'V2024EntitlementRequestConfig'] +--- + +# EntitlementRequestConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**allow_entitlement_request** | **bool** | If this is true, entitlement requests are allowed. | [optional] [default to False] +**request_comments_required** | **bool** | If this is true, comments are required to submit entitlement requests. | [optional] [default to False] +**denied_comments_required** | **bool** | If this is true, comments are required to reject entitlement requests. | [optional] [default to False] +**grant_request_approval_schemes** | **str** | Approval schemes for granting entitlement request. This can be empty if no approval is needed. Multiple schemes must be comma-separated. The valid schemes are \"entitlementOwner\", \"sourceOwner\", \"manager\" and \"`workgroup:{id}`\". You can use multiple governance groups (workgroups). | [optional] [default to 'sourceOwner'] +} + +## Example + +```python +from sailpoint.v2024.models.entitlement_request_config import EntitlementRequestConfig + +entitlement_request_config = EntitlementRequestConfig( +allow_entitlement_request=True, +request_comments_required=False, +denied_comments_required=False, +grant_request_approval_schemes='sourceOwner' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/EntitlementSource.md b/docs/tools/sdk/python/Reference/V2024/Models/EntitlementSource.md new file mode 100644 index 000000000..0909b07ad --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/EntitlementSource.md @@ -0,0 +1,37 @@ +--- +id: v2024-entitlement-source +title: EntitlementSource +pagination_label: EntitlementSource +sidebar_label: EntitlementSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementSource', 'V2024EntitlementSource'] +slug: /tools/sdk/python/v2024/models/entitlement-source +tags: ['SDK', 'Software Development Kit', 'EntitlementSource', 'V2024EntitlementSource'] +--- + +# EntitlementSource + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The source ID | [optional] +**type** | **str** | The source type, will always be \"SOURCE\" | [optional] +**name** | **str** | The source name | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.entitlement_source import EntitlementSource + +entitlement_source = EntitlementSource( +id='2c9180827ca885d7017ca8ce28a000eb', +type='SOURCE', +name='ODS-AD-Source' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/EntitlementSourceResetBaseReferenceDto.md b/docs/tools/sdk/python/Reference/V2024/Models/EntitlementSourceResetBaseReferenceDto.md new file mode 100644 index 000000000..3e1786688 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/EntitlementSourceResetBaseReferenceDto.md @@ -0,0 +1,37 @@ +--- +id: v2024-entitlement-source-reset-base-reference-dto +title: EntitlementSourceResetBaseReferenceDto +pagination_label: EntitlementSourceResetBaseReferenceDto +sidebar_label: EntitlementSourceResetBaseReferenceDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementSourceResetBaseReferenceDto', 'V2024EntitlementSourceResetBaseReferenceDto'] +slug: /tools/sdk/python/v2024/models/entitlement-source-reset-base-reference-dto +tags: ['SDK', 'Software Development Kit', 'EntitlementSourceResetBaseReferenceDto', 'V2024EntitlementSourceResetBaseReferenceDto'] +--- + +# EntitlementSourceResetBaseReferenceDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | The DTO type | [optional] +**id** | **str** | The task ID of the object to which this reference applies | [optional] +**name** | **str** | Human-readable display name of the object to which this reference applies | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.entitlement_source_reset_base_reference_dto import EntitlementSourceResetBaseReferenceDto + +entitlement_source_reset_base_reference_dto = EntitlementSourceResetBaseReferenceDto( +type='TASK_RESULT', +id='2c91808568c529c60168cca6f90c1313', +name='Entitlement Source Reset' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/EntitlementSummary.md b/docs/tools/sdk/python/Reference/V2024/Models/EntitlementSummary.md new file mode 100644 index 000000000..2e6110038 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/EntitlementSummary.md @@ -0,0 +1,54 @@ +--- +id: v2024-entitlement-summary +title: EntitlementSummary +pagination_label: EntitlementSummary +sidebar_label: EntitlementSummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementSummary', 'V2024EntitlementSummary'] +slug: /tools/sdk/python/v2024/models/entitlement-summary +tags: ['SDK', 'Software Development Kit', 'EntitlementSummary', 'V2024EntitlementSummary'] +--- + +# EntitlementSummary + +EntitlementReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the referenced object. | [optional] +**name** | **str** | The human readable name of the referenced object. | [optional] +**display_name** | **str** | | [optional] +**description** | **str** | Description of access item. | [optional] +**source** | [**Reference**](reference) | | [optional] +**type** | **str** | Type of the access item. | [optional] +**privileged** | **bool** | | [optional] +**attribute** | **str** | | [optional] +**value** | **str** | | [optional] +**standalone** | **bool** | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.entitlement_summary import EntitlementSummary + +entitlement_summary = EntitlementSummary( +id='2c91808568c529c60168cca6f90c1313', +name='John Doe', +display_name='John Q. Doe', +description='', +source=sailpoint.v2024.models.reference.Reference( + id = '2c91808568c529c60168cca6f90c1313', + name = 'John Doe', ), +type='ENTITLEMENT', +privileged=False, +attribute='memberOf', +value='CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com', +standalone=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/EntityCreatedByDTO.md b/docs/tools/sdk/python/Reference/V2024/Models/EntityCreatedByDTO.md new file mode 100644 index 000000000..c040c2c31 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/EntityCreatedByDTO.md @@ -0,0 +1,35 @@ +--- +id: v2024-entity-created-by-dto +title: EntityCreatedByDTO +pagination_label: EntityCreatedByDTO +sidebar_label: EntityCreatedByDTO +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntityCreatedByDTO', 'V2024EntityCreatedByDTO'] +slug: /tools/sdk/python/v2024/models/entity-created-by-dto +tags: ['SDK', 'Software Development Kit', 'EntityCreatedByDTO', 'V2024EntityCreatedByDTO'] +--- + +# EntityCreatedByDTO + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the creator | [optional] +**display_name** | **str** | The display name of the creator | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.entity_created_by_dto import EntityCreatedByDTO + +entity_created_by_dto = EntityCreatedByDTO( +id='2c918090761a5aac0176215c46a62d58', +display_name='Ashley.Pierce' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Error.md b/docs/tools/sdk/python/Reference/V2024/Models/Error.md new file mode 100644 index 000000000..821d85ed4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Error.md @@ -0,0 +1,42 @@ +--- +id: v2024-error +title: Error +pagination_label: Error +sidebar_label: Error +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Error', 'V2024Error'] +slug: /tools/sdk/python/v2024/models/error +tags: ['SDK', 'Software Development Kit', 'Error', 'V2024Error'] +--- + +# Error + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detail_code** | **str** | DetailCode is the text of the status code returned | [optional] +**messages** | [**[]ErrorMessage**](error-message) | | [optional] +**tracking_id** | **str** | TrackingID is the request tracking unique identifier | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.error import Error + +error = Error( +detail_code='Internal Server Error', +messages=[ + sailpoint.v2024.models.error_message_is_the_standard_api_error_response_message_type/.ErrorMessage is the standard API error response message type.( + locale = 'en-US', + locale_origin = 'DEFAULT', + text = 'This is an error', ) + ], +tracking_id='9cd03ef80e6a425eb6b11bdbb057cdb4' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ErrorMessage.md b/docs/tools/sdk/python/Reference/V2024/Models/ErrorMessage.md new file mode 100644 index 000000000..aa5818965 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ErrorMessage.md @@ -0,0 +1,37 @@ +--- +id: v2024-error-message +title: ErrorMessage +pagination_label: ErrorMessage +sidebar_label: ErrorMessage +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ErrorMessage', 'V2024ErrorMessage'] +slug: /tools/sdk/python/v2024/models/error-message +tags: ['SDK', 'Software Development Kit', 'ErrorMessage', 'V2024ErrorMessage'] +--- + +# ErrorMessage + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **str** | Locale is the current Locale | [optional] +**locale_origin** | **str** | LocaleOrigin holds possible values of how the locale was selected | [optional] +**text** | **str** | Text is the actual text of the error message | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.error_message import ErrorMessage + +error_message = ErrorMessage( +locale='en-US', +locale_origin='DEFAULT', +text='This is an error' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ErrorMessageDto.md b/docs/tools/sdk/python/Reference/V2024/Models/ErrorMessageDto.md new file mode 100644 index 000000000..52374d517 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ErrorMessageDto.md @@ -0,0 +1,37 @@ +--- +id: v2024-error-message-dto +title: ErrorMessageDto +pagination_label: ErrorMessageDto +sidebar_label: ErrorMessageDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ErrorMessageDto', 'V2024ErrorMessageDto'] +slug: /tools/sdk/python/v2024/models/error-message-dto +tags: ['SDK', 'Software Development Kit', 'ErrorMessageDto', 'V2024ErrorMessageDto'] +--- + +# ErrorMessageDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **str** | The locale for the message text, a BCP 47 language tag. | [optional] +**locale_origin** | [**LocaleOrigin**](locale-origin) | | [optional] +**text** | **str** | Actual text of the error message in the indicated locale. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.error_message_dto import ErrorMessageDto + +error_message_dto = ErrorMessageDto( +locale='en-US', +locale_origin='DEFAULT', +text='The request was syntactically correct but its content is semantically invalid.' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ErrorResponseDto.md b/docs/tools/sdk/python/Reference/V2024/Models/ErrorResponseDto.md new file mode 100644 index 000000000..f196b4d73 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ErrorResponseDto.md @@ -0,0 +1,49 @@ +--- +id: v2024-error-response-dto +title: ErrorResponseDto +pagination_label: ErrorResponseDto +sidebar_label: ErrorResponseDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ErrorResponseDto', 'V2024ErrorResponseDto'] +slug: /tools/sdk/python/v2024/models/error-response-dto +tags: ['SDK', 'Software Development Kit', 'ErrorResponseDto', 'V2024ErrorResponseDto'] +--- + +# ErrorResponseDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detail_code** | **str** | Fine-grained error code providing more detail of the error. | [optional] +**tracking_id** | **str** | Unique tracking id for the error. | [optional] +**messages** | [**[]ErrorMessageDto**](error-message-dto) | Generic localized reason for error | [optional] +**causes** | [**[]ErrorMessageDto**](error-message-dto) | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.error_response_dto import ErrorResponseDto + +error_response_dto = ErrorResponseDto( +detail_code='400.1 Bad Request Content', +tracking_id='e7eab60924f64aa284175b9fa3309599', +messages=[ + sailpoint.v2024.models.error_message_dto.ErrorMessageDto( + locale = 'en-US', + locale_origin = 'DEFAULT', + text = 'The request was syntactically correct but its content is semantically invalid.', ) + ], +causes=[ + sailpoint.v2024.models.error_message_dto.ErrorMessageDto( + locale = 'en-US', + locale_origin = 'DEFAULT', + text = 'The request was syntactically correct but its content is semantically invalid.', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/EvaluateResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/EvaluateResponse.md new file mode 100644 index 000000000..e553c2760 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/EvaluateResponse.md @@ -0,0 +1,41 @@ +--- +id: v2024-evaluate-response +title: EvaluateResponse +pagination_label: EvaluateResponse +sidebar_label: EvaluateResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EvaluateResponse', 'V2024EvaluateResponse'] +slug: /tools/sdk/python/v2024/models/evaluate-response +tags: ['SDK', 'Software Development Kit', 'EvaluateResponse', 'V2024EvaluateResponse'] +--- + +# EvaluateResponse + +The response body for Evaluate Reassignment Configuration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reassign_to_id** | **str** | The Identity ID which should be the recipient of any work items sent to a specific identity & work type | [optional] +**lookup_trail** | [**[]LookupStep**](lookup-step) | List of Reassignments found by looking up the next `TargetIdentity` in a ReassignmentConfiguration | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.evaluate_response import EvaluateResponse + +evaluate_response = EvaluateResponse( +reassign_to_id='869320b6b6f34a169b6178b1a865e66f', +lookup_trail=[ + sailpoint.v2024.models.lookup_step.LookupStep( + reassigned_to_id = '869320b6b6f34a169b6178b1a865e66f', + reassigned_from_id = '51948a8f306a4e7a9a6f8f5d032fa59e', + reassignment_type = 'AUTOMATIC_REASSIGNMENT', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Event.md b/docs/tools/sdk/python/Reference/V2024/Models/Event.md new file mode 100644 index 000000000..487048260 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Event.md @@ -0,0 +1,70 @@ +--- +id: v2024-event +title: Event +pagination_label: Event +sidebar_label: Event +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Event', 'V2024Event'] +slug: /tools/sdk/python/v2024/models/event +tags: ['SDK', 'Software Development Kit', 'Event', 'V2024Event'] +--- + +# Event + +Event + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the entitlement. | [optional] +**name** | **str** | Name of the entitlement. | [optional] +**created** | **datetime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**synced** | **str** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**action** | **str** | Name of the event as it's displayed in audit reports. | [optional] +**type** | **str** | Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. | [optional] +**actor** | [**EventActor**](event-actor) | | [optional] +**target** | [**EventTarget**](event-target) | | [optional] +**stack** | **str** | The event's stack. | [optional] +**tracking_number** | **str** | ID of the group of events. | [optional] +**ip_address** | **str** | Target system's IP address. | [optional] +**details** | **str** | ID of event's details. | [optional] +**attributes** | **map[string]object** | Attributes involved in the event. | [optional] +**objects** | **[]str** | Objects the event is happening to. | [optional] +**operation** | **str** | Operation, or action, performed during the event. | [optional] +**status** | **str** | Event status. Refer to [Event Statuses](https://documentation.sailpoint.com/saas/help/search/index.html#event-statuses) for a list of event statuses and their meanings. | [optional] +**technical_name** | **str** | Event's normalized name. This normalized name always follows the pattern of 'objects_operation_status'. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.event import Event + +event = Event( +id='2c91808375d8e80a0175e1f88a575222', +name='Add Entitlement Passed', +created='2018-06-25T20:22:28.104Z', +synced='2018-06-25T20:22:28.104Z', +action='AddEntitlement', +type='ACCESS_ITEM', +actor=sailpoint.v2024.models.event_actor.Event_actor( + name = 'System', ), +target=sailpoint.v2024.models.event_target.Event_target( + name = 'Carol.Adams', ), +stack='tpe', +tracking_number='63f891e0735f4cc8bf1968144a1e7440', +ip_address='52.52.97.85', +details='73b65dfbed1842548c207432a18c84b0', +attributes={pod=stg03-useast1, org=acme, sourceName=SailPoint}, +objects=[ + 'AUTHENTICATION' + ], +operation='ADD', +status='PASSED', +technical_name='ENTITLEMENT_ADD_PASSED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/EventActor.md b/docs/tools/sdk/python/Reference/V2024/Models/EventActor.md new file mode 100644 index 000000000..d3c49f5e5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/EventActor.md @@ -0,0 +1,33 @@ +--- +id: v2024-event-actor +title: EventActor +pagination_label: EventActor +sidebar_label: EventActor +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EventActor', 'V2024EventActor'] +slug: /tools/sdk/python/v2024/models/event-actor +tags: ['SDK', 'Software Development Kit', 'EventActor', 'V2024EventActor'] +--- + +# EventActor + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the actor that generated the event. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.event_actor import EventActor + +event_actor = EventActor( +name='System' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/EventAttributes.md b/docs/tools/sdk/python/Reference/V2024/Models/EventAttributes.md new file mode 100644 index 000000000..32bc57939 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/EventAttributes.md @@ -0,0 +1,42 @@ +--- +id: v2024-event-attributes +title: EventAttributes +pagination_label: EventAttributes +sidebar_label: EventAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EventAttributes', 'V2024EventAttributes'] +slug: /tools/sdk/python/v2024/models/event-attributes +tags: ['SDK', 'Software Development Kit', 'EventAttributes', 'V2024EventAttributes'] +--- + +# EventAttributes + +Attributes related to an IdentityNow ETS event + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the trigger | [required] +**filter_** | **str** | JSON path expression that will limit which events the trigger will fire on | [optional] +**description** | **str** | Description of the event trigger | [optional] +**attribute_to_filter** | **str** | The attribute to filter on | [optional] +**form_definition_id** | **str** | Form definition's unique identifier. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.event_attributes import EventAttributes + +event_attributes = EventAttributes( +id='idn:identity-attributes-changed', +filter_='$.changes[?(@.attribute == 'manager')]', +description='Triggered when an identity's manager attribute changes', +attribute_to_filter='LifecycleState', +form_definition_id='Admin_Access_Request_Form' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/EventBridgeConfig.md b/docs/tools/sdk/python/Reference/V2024/Models/EventBridgeConfig.md new file mode 100644 index 000000000..ae2fab588 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/EventBridgeConfig.md @@ -0,0 +1,35 @@ +--- +id: v2024-event-bridge-config +title: EventBridgeConfig +pagination_label: EventBridgeConfig +sidebar_label: EventBridgeConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EventBridgeConfig', 'V2024EventBridgeConfig'] +slug: /tools/sdk/python/v2024/models/event-bridge-config +tags: ['SDK', 'Software Development Kit', 'EventBridgeConfig', 'V2024EventBridgeConfig'] +--- + +# EventBridgeConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**aws_account** | **str** | AWS Account Number (12-digit number) that has the EventBridge Partner Event Source Resource. | [required] +**aws_region** | **str** | AWS Region that has the EventBridge Partner Event Source Resource. See https://docs.aws.amazon.com/general/latest/gr/rande.html for a full list of available values. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.event_bridge_config import EventBridgeConfig + +event_bridge_config = EventBridgeConfig( +aws_account='123456789012', +aws_region='us-west-1' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/EventDocument.md b/docs/tools/sdk/python/Reference/V2024/Models/EventDocument.md new file mode 100644 index 000000000..f0b4baa2d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/EventDocument.md @@ -0,0 +1,70 @@ +--- +id: v2024-event-document +title: EventDocument +pagination_label: EventDocument +sidebar_label: EventDocument +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EventDocument', 'V2024EventDocument'] +slug: /tools/sdk/python/v2024/models/event-document +tags: ['SDK', 'Software Development Kit', 'EventDocument', 'V2024EventDocument'] +--- + +# EventDocument + +Event + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the entitlement. | [optional] +**name** | **str** | Name of the entitlement. | [optional] +**created** | **datetime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**synced** | **str** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**action** | **str** | Name of the event as it's displayed in audit reports. | [optional] +**type** | **str** | Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. | [optional] +**actor** | [**EventActor**](event-actor) | | [optional] +**target** | [**EventTarget**](event-target) | | [optional] +**stack** | **str** | The event's stack. | [optional] +**tracking_number** | **str** | ID of the group of events. | [optional] +**ip_address** | **str** | Target system's IP address. | [optional] +**details** | **str** | ID of event's details. | [optional] +**attributes** | **map[string]object** | Attributes involved in the event. | [optional] +**objects** | **[]str** | Objects the event is happening to. | [optional] +**operation** | **str** | Operation, or action, performed during the event. | [optional] +**status** | **str** | Event status. Refer to [Event Statuses](https://documentation.sailpoint.com/saas/help/search/index.html#event-statuses) for a list of event statuses and their meanings. | [optional] +**technical_name** | **str** | Event's normalized name. This normalized name always follows the pattern of 'objects_operation_status'. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.event_document import EventDocument + +event_document = EventDocument( +id='2c91808375d8e80a0175e1f88a575222', +name='Add Entitlement Passed', +created='2018-06-25T20:22:28.104Z', +synced='2018-06-25T20:22:28.104Z', +action='AddEntitlement', +type='ACCESS_ITEM', +actor=sailpoint.v2024.models.event_actor.Event_actor( + name = 'System', ), +target=sailpoint.v2024.models.event_target.Event_target( + name = 'Carol.Adams', ), +stack='tpe', +tracking_number='63f891e0735f4cc8bf1968144a1e7440', +ip_address='52.52.97.85', +details='73b65dfbed1842548c207432a18c84b0', +attributes={pod=stg03-useast1, org=acme, sourceName=SailPoint}, +objects=[ + 'AUTHENTICATION' + ], +operation='ADD', +status='PASSED', +technical_name='ENTITLEMENT_ADD_PASSED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/EventTarget.md b/docs/tools/sdk/python/Reference/V2024/Models/EventTarget.md new file mode 100644 index 000000000..8c7aaf597 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/EventTarget.md @@ -0,0 +1,33 @@ +--- +id: v2024-event-target +title: EventTarget +pagination_label: EventTarget +sidebar_label: EventTarget +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EventTarget', 'V2024EventTarget'] +slug: /tools/sdk/python/v2024/models/event-target +tags: ['SDK', 'Software Development Kit', 'EventTarget', 'V2024EventTarget'] +--- + +# EventTarget + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the target, or recipient, of the event. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.event_target import EventTarget + +event_target = EventTarget( +name='Carol.Adams' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ExceptionAccessCriteria.md b/docs/tools/sdk/python/Reference/V2024/Models/ExceptionAccessCriteria.md new file mode 100644 index 000000000..e324efbe9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ExceptionAccessCriteria.md @@ -0,0 +1,37 @@ +--- +id: v2024-exception-access-criteria +title: ExceptionAccessCriteria +pagination_label: ExceptionAccessCriteria +sidebar_label: ExceptionAccessCriteria +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ExceptionAccessCriteria', 'V2024ExceptionAccessCriteria'] +slug: /tools/sdk/python/v2024/models/exception-access-criteria +tags: ['SDK', 'Software Development Kit', 'ExceptionAccessCriteria', 'V2024ExceptionAccessCriteria'] +--- + +# ExceptionAccessCriteria + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**left_criteria** | [**ExceptionCriteria**](exception-criteria) | | [optional] +**right_criteria** | [**ExceptionCriteria**](exception-criteria) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.exception_access_criteria import ExceptionAccessCriteria + +exception_access_criteria = ExceptionAccessCriteria( +left_criteria=sailpoint.v2024.models.exception_criteria.ExceptionCriteria( + criteria_list = [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, existing=true}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, existing=false}], ), +right_criteria=sailpoint.v2024.models.exception_criteria.ExceptionCriteria( + criteria_list = [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, existing=true}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, existing=false}], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ExceptionCriteria.md b/docs/tools/sdk/python/Reference/V2024/Models/ExceptionCriteria.md new file mode 100644 index 000000000..395a53941 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ExceptionCriteria.md @@ -0,0 +1,33 @@ +--- +id: v2024-exception-criteria +title: ExceptionCriteria +pagination_label: ExceptionCriteria +sidebar_label: ExceptionCriteria +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ExceptionCriteria', 'V2024ExceptionCriteria'] +slug: /tools/sdk/python/v2024/models/exception-criteria +tags: ['SDK', 'Software Development Kit', 'ExceptionCriteria', 'V2024ExceptionCriteria'] +--- + +# ExceptionCriteria + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**criteria_list** | [**[]ExceptionCriteriaCriteriaListInner**](exception-criteria-criteria-list-inner) | List of exception criteria. There is a min of 1 and max of 50 items in the list. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.exception_criteria import ExceptionCriteria + +exception_criteria = ExceptionCriteria( +criteria_list=[{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, existing=true}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, existing=false}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ExceptionCriteriaAccess.md b/docs/tools/sdk/python/Reference/V2024/Models/ExceptionCriteriaAccess.md new file mode 100644 index 000000000..0abba229b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ExceptionCriteriaAccess.md @@ -0,0 +1,40 @@ +--- +id: v2024-exception-criteria-access +title: ExceptionCriteriaAccess +pagination_label: ExceptionCriteriaAccess +sidebar_label: ExceptionCriteriaAccess +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ExceptionCriteriaAccess', 'V2024ExceptionCriteriaAccess'] +slug: /tools/sdk/python/v2024/models/exception-criteria-access +tags: ['SDK', 'Software Development Kit', 'ExceptionCriteriaAccess', 'V2024ExceptionCriteriaAccess'] +--- + +# ExceptionCriteriaAccess + +Access reference with addition of boolean existing flag to indicate whether the access was extant + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**DtoType**](dto-type) | | [optional] +**id** | **str** | ID of the object to which this reference applies | [optional] +**name** | **str** | Human-readable display name of the object to which this reference applies | [optional] +**existing** | **bool** | Whether the subject identity already had that access or not | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.exception_criteria_access import ExceptionCriteriaAccess + +exception_criteria_access = ExceptionCriteriaAccess( +type='IDENTITY', +id='2c91808568c529c60168cca6f90c1313', +name='CN=HelpDesk,OU=test,OU=test-service,DC=TestAD,DC=local', +existing=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ExceptionCriteriaCriteriaListInner.md b/docs/tools/sdk/python/Reference/V2024/Models/ExceptionCriteriaCriteriaListInner.md new file mode 100644 index 000000000..86e250043 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ExceptionCriteriaCriteriaListInner.md @@ -0,0 +1,40 @@ +--- +id: v2024-exception-criteria-criteria-list-inner +title: ExceptionCriteriaCriteriaListInner +pagination_label: ExceptionCriteriaCriteriaListInner +sidebar_label: ExceptionCriteriaCriteriaListInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ExceptionCriteriaCriteriaListInner', 'V2024ExceptionCriteriaCriteriaListInner'] +slug: /tools/sdk/python/v2024/models/exception-criteria-criteria-list-inner +tags: ['SDK', 'Software Development Kit', 'ExceptionCriteriaCriteriaListInner', 'V2024ExceptionCriteriaCriteriaListInner'] +--- + +# ExceptionCriteriaCriteriaListInner + +The types of objects supported for SOD violations + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ENTITLEMENT' ] | The type of object that is referenced | [optional] +**id** | **str** | ID of the object to which this reference applies | [optional] +**name** | **str** | Human-readable display name of the object to which this reference applies | [optional] +**existing** | **bool** | Whether the subject identity already had that access or not | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.exception_criteria_criteria_list_inner import ExceptionCriteriaCriteriaListInner + +exception_criteria_criteria_list_inner = ExceptionCriteriaCriteriaListInner( +type=ENTITLEMENT, +id='2c91808568c529c60168cca6f90c1313', +name='CN=HelpDesk,OU=test,OU=test-service,DC=TestAD,DC=local', +existing=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ExecutionStatus.md b/docs/tools/sdk/python/Reference/V2024/Models/ExecutionStatus.md new file mode 100644 index 000000000..5ed4fad35 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ExecutionStatus.md @@ -0,0 +1,27 @@ +--- +id: v2024-execution-status +title: ExecutionStatus +pagination_label: ExecutionStatus +sidebar_label: ExecutionStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ExecutionStatus', 'V2024ExecutionStatus'] +slug: /tools/sdk/python/v2024/models/execution-status +tags: ['SDK', 'Software Development Kit', 'ExecutionStatus', 'V2024ExecutionStatus'] +--- + +# ExecutionStatus + +The current state of execution. + +## Enum + +* `EXECUTING` (value: `'EXECUTING'`) + +* `VERIFYING` (value: `'VERIFYING'`) + +* `TERMINATED` (value: `'TERMINATED'`) + +* `COMPLETED` (value: `'COMPLETED'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ExpansionItem.md b/docs/tools/sdk/python/Reference/V2024/Models/ExpansionItem.md new file mode 100644 index 000000000..1fb2d8677 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ExpansionItem.md @@ -0,0 +1,48 @@ +--- +id: v2024-expansion-item +title: ExpansionItem +pagination_label: ExpansionItem +sidebar_label: ExpansionItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ExpansionItem', 'V2024ExpansionItem'] +slug: /tools/sdk/python/v2024/models/expansion-item +tags: ['SDK', 'Software Development Kit', 'ExpansionItem', 'V2024ExpansionItem'] +--- + +# ExpansionItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_id** | **str** | The ID of the account | [optional] +**cause** | **str** | Cause of the expansion item. | [optional] +**name** | **str** | The name of the item | [optional] +**attribute_request** | [**AttributeRequest**](attribute-request) | | [optional] +**source** | [**AccountSource**](account-source) | | [optional] +**id** | **str** | ID of the expansion item | [optional] +**state** | **str** | State of the expansion item | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.expansion_item import ExpansionItem + +expansion_item = ExpansionItem( +account_id='2c91808981f58ea601821c3e93482e6f', +cause='Role', +name='smartsheet-role', +attribute_request=sailpoint.v2024.models.attribute_request.AttributeRequest( + name = 'groups', + op = 'Add', + value = null, ), +source=, +id='ac2887ffe0e7435a8c18c73f7ae94c7b', +state='EXECUTING' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ExportFormDefinitionsByTenant200ResponseInner.md b/docs/tools/sdk/python/Reference/V2024/Models/ExportFormDefinitionsByTenant200ResponseInner.md new file mode 100644 index 000000000..9b077ba7f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ExportFormDefinitionsByTenant200ResponseInner.md @@ -0,0 +1,93 @@ +--- +id: v2024-export-form-definitions-by-tenant200-response-inner +title: ExportFormDefinitionsByTenant200ResponseInner +pagination_label: ExportFormDefinitionsByTenant200ResponseInner +sidebar_label: ExportFormDefinitionsByTenant200ResponseInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ExportFormDefinitionsByTenant200ResponseInner', 'V2024ExportFormDefinitionsByTenant200ResponseInner'] +slug: /tools/sdk/python/v2024/models/export-form-definitions-by-tenant200-response-inner +tags: ['SDK', 'Software Development Kit', 'ExportFormDefinitionsByTenant200ResponseInner', 'V2024ExportFormDefinitionsByTenant200ResponseInner'] +--- + +# ExportFormDefinitionsByTenant200ResponseInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**object** | [**FormDefinitionResponse**](form-definition-response) | | [optional] +**var_self** | [**ExportFormDefinitionsByTenant200ResponseInnerSelf**](export-form-definitions-by-tenant200-response-inner-self) | | [optional] +**version** | **int** | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.export_form_definitions_by_tenant200_response_inner import ExportFormDefinitionsByTenant200ResponseInner + +export_form_definitions_by_tenant200_response_inner = ExportFormDefinitionsByTenant200ResponseInner( +object=sailpoint.v2024.models.form_definition_response.FormDefinitionResponse( + id = '00000000-0000-0000-0000-000000000000', + name = 'My form', + description = 'My form description', + owner = sailpoint.v2024.models.form_owner.FormOwner( + type = 'IDENTITY', + id = '2c9180867624cbd7017642d8c8c81f67', + name = 'Grant Smith', ), + used_by = [ + sailpoint.v2024.models.form_used_by.FormUsedBy( + type = 'WORKFLOW', + id = '61940a92-5484-42bc-bc10-b9982b218cdf', + name = 'Access Request Form', ) + ], + form_input = [ + sailpoint.v2024.models.form_definition_input.FormDefinitionInput( + id = '00000000-0000-0000-0000-000000000000', + type = 'STRING', + label = 'input1', + description = 'A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic', ) + ], + form_elements = [ + sailpoint.v2024.models.form_element.FormElement( + id = '00000000-0000-0000-0000-000000000000', + element_type = 'TEXT', + config = {label=Department}, + key = 'department', + validations = [ + sailpoint.v2024.models.form_element_validations_set.FormElementValidationsSet( + validation_type = 'REQUIRED', ) + ], ) + ], + form_conditions = [ + sailpoint.v2024.models.form_condition.FormCondition( + rule_operator = 'AND', + rules = [ + sailpoint.v2024.models.condition_rule.ConditionRule( + source_type = 'ELEMENT', + source = 'department', + operator = 'EQ', + value_type = 'STRING', + value = 'Engineering', ) + ], + effects = [ + sailpoint.v2024.models.condition_effect.ConditionEffect( + effect_type = 'HIDE', + config = sailpoint.v2024.models.condition_effect_config.ConditionEffect_config( + default_value_label = 'Access to Remove', + element = '8110662963316867', ), ) + ], ) + ], + created = '2023-07-12T20:14:57.744860Z', + modified = '2023-07-12T20:14:57.744860Z', ), +var_self=sailpoint.v2024.models.export_form_definitions_by_tenant_200_response_inner_self.exportFormDefinitionsByTenant_200_response_inner_self( + object = sailpoint.v2024.models.form_definition_self_import_export_dto.FormDefinitionSelfImportExportDto( + type = 'FORM_DEFINITION', + id = '2c9180835d191a86015d28455b4b232a', + name = 'Temporary User Level Permissions - Requester', ), ), +version=56 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ExportFormDefinitionsByTenant200ResponseInnerSelf.md b/docs/tools/sdk/python/Reference/V2024/Models/ExportFormDefinitionsByTenant200ResponseInnerSelf.md new file mode 100644 index 000000000..e987b33e6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ExportFormDefinitionsByTenant200ResponseInnerSelf.md @@ -0,0 +1,36 @@ +--- +id: v2024-export-form-definitions-by-tenant200-response-inner-self +title: ExportFormDefinitionsByTenant200ResponseInnerSelf +pagination_label: ExportFormDefinitionsByTenant200ResponseInnerSelf +sidebar_label: ExportFormDefinitionsByTenant200ResponseInnerSelf +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ExportFormDefinitionsByTenant200ResponseInnerSelf', 'V2024ExportFormDefinitionsByTenant200ResponseInnerSelf'] +slug: /tools/sdk/python/v2024/models/export-form-definitions-by-tenant200-response-inner-self +tags: ['SDK', 'Software Development Kit', 'ExportFormDefinitionsByTenant200ResponseInnerSelf', 'V2024ExportFormDefinitionsByTenant200ResponseInnerSelf'] +--- + +# ExportFormDefinitionsByTenant200ResponseInnerSelf + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**object** | [**FormDefinitionSelfImportExportDto**](form-definition-self-import-export-dto) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.export_form_definitions_by_tenant200_response_inner_self import ExportFormDefinitionsByTenant200ResponseInnerSelf + +export_form_definitions_by_tenant200_response_inner_self = ExportFormDefinitionsByTenant200ResponseInnerSelf( +object=sailpoint.v2024.models.form_definition_self_import_export_dto.FormDefinitionSelfImportExportDto( + type = 'FORM_DEFINITION', + id = '2c9180835d191a86015d28455b4b232a', + name = 'Temporary User Level Permissions - Requester', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ExportOptions.md b/docs/tools/sdk/python/Reference/V2024/Models/ExportOptions.md new file mode 100644 index 000000000..6936f65a3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ExportOptions.md @@ -0,0 +1,41 @@ +--- +id: v2024-export-options +title: ExportOptions +pagination_label: ExportOptions +sidebar_label: ExportOptions +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ExportOptions', 'V2024ExportOptions'] +slug: /tools/sdk/python/v2024/models/export-options +tags: ['SDK', 'Software Development Kit', 'ExportOptions', 'V2024ExportOptions'] +--- + +# ExportOptions + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**exclude_types** | **[]str** | Object type names to be excluded from an sp-config export command. | [optional] +**include_types** | **[]str** | Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. | [optional] +**object_options** | [**map[string]ObjectExportImportOptions**](object-export-import-options) | Additional options targeting specific objects related to each item in the includeTypes field | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.export_options import ExportOptions + +export_options = ExportOptions( +exclude_types=[ + 'SOURCE' + ], +include_types=[ + 'TRIGGER_SUBSCRIPTION' + ], +object_options={TRIGGER_SUBSCRIPTION={includedIds=[be9e116d-08e1-49fc-ab7f-fa585e96c9e4], includedNames=[Test 2]}} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ExportOptions1.md b/docs/tools/sdk/python/Reference/V2024/Models/ExportOptions1.md new file mode 100644 index 000000000..32906ea70 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ExportOptions1.md @@ -0,0 +1,41 @@ +--- +id: v2024-export-options1 +title: ExportOptions1 +pagination_label: ExportOptions1 +sidebar_label: ExportOptions1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ExportOptions1', 'V2024ExportOptions1'] +slug: /tools/sdk/python/v2024/models/export-options1 +tags: ['SDK', 'Software Development Kit', 'ExportOptions1', 'V2024ExportOptions1'] +--- + +# ExportOptions1 + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**exclude_types** | **[]str** | Object type names to be excluded from an sp-config export command. | [optional] +**include_types** | **[]str** | Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. | [optional] +**object_options** | [**map[string]ObjectExportImportOptions**](object-export-import-options) | Additional options targeting specific objects related to each item in the includeTypes field | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.export_options1 import ExportOptions1 + +export_options1 = ExportOptions1( +exclude_types=[ + 'SOURCE' + ], +include_types=[ + 'TRIGGER_SUBSCRIPTION' + ], +object_options={TRIGGER_SUBSCRIPTION={includedIds=[be9e116d-08e1-49fc-ab7f-fa585e96c9e4], includedNames=[Test 2]}} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ExportPayload.md b/docs/tools/sdk/python/Reference/V2024/Models/ExportPayload.md new file mode 100644 index 000000000..22214df0f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ExportPayload.md @@ -0,0 +1,43 @@ +--- +id: v2024-export-payload +title: ExportPayload +pagination_label: ExportPayload +sidebar_label: ExportPayload +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ExportPayload', 'V2024ExportPayload'] +slug: /tools/sdk/python/v2024/models/export-payload +tags: ['SDK', 'Software Development Kit', 'ExportPayload', 'V2024ExportPayload'] +--- + +# ExportPayload + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **str** | Optional user defined description/name for export job. | [optional] +**exclude_types** | **[]str** | Object type names to be excluded from an sp-config export command. | [optional] +**include_types** | **[]str** | Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. | [optional] +**object_options** | [**map[string]ObjectExportImportOptions**](object-export-import-options) | Additional options targeting specific objects related to each item in the includeTypes field | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.export_payload import ExportPayload + +export_payload = ExportPayload( +description='Export Job 1 Test', +exclude_types=[ + 'SOURCE' + ], +include_types=[ + 'TRIGGER_SUBSCRIPTION' + ], +object_options={TRIGGER_SUBSCRIPTION={includedIds=[be9e116d-08e1-49fc-ab7f-fa585e96c9e4], includedNames=[Test 2]}} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Expression.md b/docs/tools/sdk/python/Reference/V2024/Models/Expression.md new file mode 100644 index 000000000..2b8f82da6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Expression.md @@ -0,0 +1,40 @@ +--- +id: v2024-expression +title: Expression +pagination_label: Expression +sidebar_label: Expression +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Expression', 'V2024Expression'] +slug: /tools/sdk/python/v2024/models/expression +tags: ['SDK', 'Software Development Kit', 'Expression', 'V2024Expression'] +--- + +# Expression + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operator** | **Enum** [ 'AND', 'EQUALS' ] | Operator for the expression | [optional] +**attribute** | **str** | Name for the attribute | [optional] +**value** | [**Value**](value) | | [optional] +**children** | [**[]ExpressionChildrenInner**](expression-children-inner) | List of expressions | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.expression import Expression + +expression = Expression( +operator='EQUALS', +attribute='location', +value=sailpoint.v2024.models.value.Value( + type = 'STRING', ), +children=[] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ExpressionChildrenInner.md b/docs/tools/sdk/python/Reference/V2024/Models/ExpressionChildrenInner.md new file mode 100644 index 000000000..64500b701 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ExpressionChildrenInner.md @@ -0,0 +1,40 @@ +--- +id: v2024-expression-children-inner +title: ExpressionChildrenInner +pagination_label: ExpressionChildrenInner +sidebar_label: ExpressionChildrenInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ExpressionChildrenInner', 'V2024ExpressionChildrenInner'] +slug: /tools/sdk/python/v2024/models/expression-children-inner +tags: ['SDK', 'Software Development Kit', 'ExpressionChildrenInner', 'V2024ExpressionChildrenInner'] +--- + +# ExpressionChildrenInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operator** | **Enum** [ 'AND', 'EQUALS' ] | Operator for the expression | [optional] +**attribute** | **str** | Name for the attribute | [optional] +**value** | [**Value**](value) | | [optional] +**children** | **str** | There cannot be anymore nested children. This will always be null. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.expression_children_inner import ExpressionChildrenInner + +expression_children_inner = ExpressionChildrenInner( +operator='EQUALS', +attribute='location', +value=sailpoint.v2024.models.value.Value( + type = 'STRING', ), +children='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ExternalAttributes.md b/docs/tools/sdk/python/Reference/V2024/Models/ExternalAttributes.md new file mode 100644 index 000000000..850e1408f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ExternalAttributes.md @@ -0,0 +1,40 @@ +--- +id: v2024-external-attributes +title: ExternalAttributes +pagination_label: ExternalAttributes +sidebar_label: ExternalAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ExternalAttributes', 'V2024ExternalAttributes'] +slug: /tools/sdk/python/v2024/models/external-attributes +tags: ['SDK', 'Software Development Kit', 'ExternalAttributes', 'V2024ExternalAttributes'] +--- + +# ExternalAttributes + +Attributes related to an external trigger + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | A unique name for the external trigger | [optional] +**description** | **str** | Additional context about the external trigger | [optional] +**client_id** | **str** | OAuth Client ID to authenticate with this trigger | [optional] +**url** | **str** | URL to invoke this workflow | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.external_attributes import ExternalAttributes + +external_attributes = ExternalAttributes( +name='search-and-notify', +description='Run a search and notify the results', +client_id='87e239b2-b85b-4bde-b9a7-55bf304ddcdc', +url='https://tenant.api.identitynow.com/beta/workflows/execute/external/c79e0079-562c-4df5-aa73-60a9e25c916d' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/FeatureValueDto.md b/docs/tools/sdk/python/Reference/V2024/Models/FeatureValueDto.md new file mode 100644 index 000000000..c9c7f3f2d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/FeatureValueDto.md @@ -0,0 +1,37 @@ +--- +id: v2024-feature-value-dto +title: FeatureValueDto +pagination_label: FeatureValueDto +sidebar_label: FeatureValueDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FeatureValueDto', 'V2024FeatureValueDto'] +slug: /tools/sdk/python/v2024/models/feature-value-dto +tags: ['SDK', 'Software Development Kit', 'FeatureValueDto', 'V2024FeatureValueDto'] +--- + +# FeatureValueDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**feature** | **str** | The type of feature | [optional] +**numerator** | **int** | The number of identities that have access to the feature | [optional] +**denominator** | **int** | The number of identities with the corresponding feature | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.feature_value_dto import FeatureValueDto + +feature_value_dto = FeatureValueDto( +feature='department', +numerator=14, +denominator=14 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/FieldDetailsDto.md b/docs/tools/sdk/python/Reference/V2024/Models/FieldDetailsDto.md new file mode 100644 index 000000000..4d443842b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/FieldDetailsDto.md @@ -0,0 +1,43 @@ +--- +id: v2024-field-details-dto +title: FieldDetailsDto +pagination_label: FieldDetailsDto +sidebar_label: FieldDetailsDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FieldDetailsDto', 'V2024FieldDetailsDto'] +slug: /tools/sdk/python/v2024/models/field-details-dto +tags: ['SDK', 'Software Development Kit', 'FieldDetailsDto', 'V2024FieldDetailsDto'] +--- + +# FieldDetailsDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the attribute. | [optional] +**transform** | **object** | The transform to apply to the field | [optional] +**attributes** | **object** | Attributes required for the transform | [optional] +**is_required** | **bool** | Flag indicating whether or not the attribute is required. | [optional] [readonly] [default to False] +**type** | **str** | The type of the attribute. | [optional] +**is_multi_valued** | **bool** | Flag indicating whether or not the attribute is multi-valued. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.field_details_dto import FieldDetailsDto + +field_details_dto = FieldDetailsDto( +name='userName', +transform={type=rule, attributes={name=Create Unique LDAP Attribute}}, +attributes={template=${firstname}.${lastname}${uniqueCounter}, cloudMaxUniqueChecks=50, cloudMaxSize=20, cloudRequired=true}, +is_required=False, +type='string', +is_multi_valued=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Filter.md b/docs/tools/sdk/python/Reference/V2024/Models/Filter.md new file mode 100644 index 000000000..d247e8b50 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Filter.md @@ -0,0 +1,47 @@ +--- +id: v2024-filter +title: Filter +pagination_label: Filter +sidebar_label: Filter +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Filter', 'V2024Filter'] +slug: /tools/sdk/python/v2024/models/filter +tags: ['SDK', 'Software Development Kit', 'Filter', 'V2024Filter'] +--- + +# Filter + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**FilterType**](filter-type) | | [optional] +**range** | [**Range**](range) | | [optional] +**terms** | **[]str** | The terms to be filtered. | [optional] +**exclude** | **bool** | Indicates if the filter excludes results. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.filter import Filter + +filter = Filter( +type='RANGE', +range=sailpoint.v2024.models.range.Range( + lower = sailpoint.v2024.models.bound.Bound( + value = '1', + inclusive = False, ), + upper = sailpoint.v2024.models.bound.Bound( + value = '1', + inclusive = False, ), ), +terms=[ + 'account_count' + ], +exclude=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/FilterAggregation.md b/docs/tools/sdk/python/Reference/V2024/Models/FilterAggregation.md new file mode 100644 index 000000000..ffbfbc4e2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/FilterAggregation.md @@ -0,0 +1,40 @@ +--- +id: v2024-filter-aggregation +title: FilterAggregation +pagination_label: FilterAggregation +sidebar_label: FilterAggregation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FilterAggregation', 'V2024FilterAggregation'] +slug: /tools/sdk/python/v2024/models/filter-aggregation +tags: ['SDK', 'Software Development Kit', 'FilterAggregation', 'V2024FilterAggregation'] +--- + +# FilterAggregation + +An additional filter to constrain the results of the search query. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the filter aggregate to be included in the result. | [required] +**type** | [**SearchFilterType**](search-filter-type) | | [optional] [default to SearchFilterType.TERM] +**var_field** | **str** | The search field to apply the filter to. Prefix the field name with '@' to reference a nested object. | [required] +**value** | **str** | The value to filter on. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.filter_aggregation import FilterAggregation + +filter_aggregation = FilterAggregation( +name='Entitlements', +type='TERM', +var_field='access.type', +value='ENTITLEMENT' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/FilterType.md b/docs/tools/sdk/python/Reference/V2024/Models/FilterType.md new file mode 100644 index 000000000..142a428c3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/FilterType.md @@ -0,0 +1,25 @@ +--- +id: v2024-filter-type +title: FilterType +pagination_label: FilterType +sidebar_label: FilterType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FilterType', 'V2024FilterType'] +slug: /tools/sdk/python/v2024/models/filter-type +tags: ['SDK', 'Software Development Kit', 'FilterType', 'V2024FilterType'] +--- + +# FilterType + +Enum representing the currently supported filter types. Additional values may be added in the future without notice. + +## Enum + +* `EXISTS` (value: `'EXISTS'`) + +* `RANGE` (value: `'RANGE'`) + +* `TERMS` (value: `'TERMS'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/FormCondition.md b/docs/tools/sdk/python/Reference/V2024/Models/FormCondition.md new file mode 100644 index 000000000..9042b551e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/FormCondition.md @@ -0,0 +1,51 @@ +--- +id: v2024-form-condition +title: FormCondition +pagination_label: FormCondition +sidebar_label: FormCondition +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormCondition', 'V2024FormCondition'] +slug: /tools/sdk/python/v2024/models/form-condition +tags: ['SDK', 'Software Development Kit', 'FormCondition', 'V2024FormCondition'] +--- + +# FormCondition + +Represent a form conditional. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**rule_operator** | **Enum** [ 'AND', 'OR' ] | ConditionRuleLogicalOperatorType value. AND ConditionRuleLogicalOperatorTypeAnd OR ConditionRuleLogicalOperatorTypeOr | [optional] +**rules** | [**[]ConditionRule**](condition-rule) | List of rules. | [optional] +**effects** | [**[]ConditionEffect**](condition-effect) | List of effects. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.form_condition import FormCondition + +form_condition = FormCondition( +rule_operator='AND', +rules=[ + sailpoint.v2024.models.condition_rule.ConditionRule( + source_type = 'ELEMENT', + source = 'department', + operator = 'EQ', + value_type = 'STRING', + value = 'Engineering', ) + ], +effects=[ + sailpoint.v2024.models.condition_effect.ConditionEffect( + effect_type = 'HIDE', + config = sailpoint.v2024.models.condition_effect_config.ConditionEffect_config( + default_value_label = 'Access to Remove', + element = '8110662963316867', ), ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/FormDefinitionDynamicSchemaRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/FormDefinitionDynamicSchemaRequest.md new file mode 100644 index 000000000..558154b14 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/FormDefinitionDynamicSchemaRequest.md @@ -0,0 +1,42 @@ +--- +id: v2024-form-definition-dynamic-schema-request +title: FormDefinitionDynamicSchemaRequest +pagination_label: FormDefinitionDynamicSchemaRequest +sidebar_label: FormDefinitionDynamicSchemaRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormDefinitionDynamicSchemaRequest', 'V2024FormDefinitionDynamicSchemaRequest'] +slug: /tools/sdk/python/v2024/models/form-definition-dynamic-schema-request +tags: ['SDK', 'Software Development Kit', 'FormDefinitionDynamicSchemaRequest', 'V2024FormDefinitionDynamicSchemaRequest'] +--- + +# FormDefinitionDynamicSchemaRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**FormDefinitionDynamicSchemaRequestAttributes**](form-definition-dynamic-schema-request-attributes) | | [optional] +**description** | **str** | Description is the form definition dynamic schema description text | [optional] +**id** | **str** | ID is a unique identifier | [optional] +**type** | **str** | Type is the form definition dynamic schema type | [optional] +**version_number** | **int** | VersionNumber is the form definition dynamic schema version number | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.form_definition_dynamic_schema_request import FormDefinitionDynamicSchemaRequest + +form_definition_dynamic_schema_request = FormDefinitionDynamicSchemaRequest( +attributes=sailpoint.v2024.models.form_definition_dynamic_schema_request_attributes.FormDefinitionDynamicSchemaRequest_attributes( + form_definition_id = '00000000-0000-0000-0000-000000000000', ), +description='A description', +id='00000000-0000-0000-0000-000000000000', +type='action', +version_number=1 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/FormDefinitionDynamicSchemaRequestAttributes.md b/docs/tools/sdk/python/Reference/V2024/Models/FormDefinitionDynamicSchemaRequestAttributes.md new file mode 100644 index 000000000..fb59c31fa --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/FormDefinitionDynamicSchemaRequestAttributes.md @@ -0,0 +1,33 @@ +--- +id: v2024-form-definition-dynamic-schema-request-attributes +title: FormDefinitionDynamicSchemaRequestAttributes +pagination_label: FormDefinitionDynamicSchemaRequestAttributes +sidebar_label: FormDefinitionDynamicSchemaRequestAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormDefinitionDynamicSchemaRequestAttributes', 'V2024FormDefinitionDynamicSchemaRequestAttributes'] +slug: /tools/sdk/python/v2024/models/form-definition-dynamic-schema-request-attributes +tags: ['SDK', 'Software Development Kit', 'FormDefinitionDynamicSchemaRequestAttributes', 'V2024FormDefinitionDynamicSchemaRequestAttributes'] +--- + +# FormDefinitionDynamicSchemaRequestAttributes + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**form_definition_id** | **str** | FormDefinitionID is a unique guid identifying this form definition | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.form_definition_dynamic_schema_request_attributes import FormDefinitionDynamicSchemaRequestAttributes + +form_definition_dynamic_schema_request_attributes = FormDefinitionDynamicSchemaRequestAttributes( +form_definition_id='00000000-0000-0000-0000-000000000000' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/FormDefinitionDynamicSchemaResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/FormDefinitionDynamicSchemaResponse.md new file mode 100644 index 000000000..6f43f5526 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/FormDefinitionDynamicSchemaResponse.md @@ -0,0 +1,33 @@ +--- +id: v2024-form-definition-dynamic-schema-response +title: FormDefinitionDynamicSchemaResponse +pagination_label: FormDefinitionDynamicSchemaResponse +sidebar_label: FormDefinitionDynamicSchemaResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormDefinitionDynamicSchemaResponse', 'V2024FormDefinitionDynamicSchemaResponse'] +slug: /tools/sdk/python/v2024/models/form-definition-dynamic-schema-response +tags: ['SDK', 'Software Development Kit', 'FormDefinitionDynamicSchemaResponse', 'V2024FormDefinitionDynamicSchemaResponse'] +--- + +# FormDefinitionDynamicSchemaResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**output_schema** | **map[string]object** | OutputSchema holds a JSON schema generated dynamically | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.form_definition_dynamic_schema_response import FormDefinitionDynamicSchemaResponse + +form_definition_dynamic_schema_response = FormDefinitionDynamicSchemaResponse( +output_schema={outputSchema={$schema=https://json-schema.org/draft/2020-12/schema, additionalProperties=false, properties={firstName={title=First Name, type=string}, fullName={title=Full Name, type=string}, lastName={title=Last Name, type=string}, startDate={format=date-time, title=Start Date, type=string}}, type=object}} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/FormDefinitionFileUploadResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/FormDefinitionFileUploadResponse.md new file mode 100644 index 000000000..b4184f584 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/FormDefinitionFileUploadResponse.md @@ -0,0 +1,37 @@ +--- +id: v2024-form-definition-file-upload-response +title: FormDefinitionFileUploadResponse +pagination_label: FormDefinitionFileUploadResponse +sidebar_label: FormDefinitionFileUploadResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormDefinitionFileUploadResponse', 'V2024FormDefinitionFileUploadResponse'] +slug: /tools/sdk/python/v2024/models/form-definition-file-upload-response +tags: ['SDK', 'Software Development Kit', 'FormDefinitionFileUploadResponse', 'V2024FormDefinitionFileUploadResponse'] +--- + +# FormDefinitionFileUploadResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **str** | Created is the date the file was uploaded | [optional] +**file_id** | **str** | fileId is a unique ULID that serves as an identifier for the form definition file | [optional] +**form_definition_id** | **str** | FormDefinitionID is a unique guid identifying this form definition | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.form_definition_file_upload_response import FormDefinitionFileUploadResponse + +form_definition_file_upload_response = FormDefinitionFileUploadResponse( +created='2023-07-12T20:14:57.74486Z', +file_id='01FHZXHK8PTP9FVK99Z66GXQTX.png', +form_definition_id='00000000-0000-0000-0000-000000000000' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/FormDefinitionInput.md b/docs/tools/sdk/python/Reference/V2024/Models/FormDefinitionInput.md new file mode 100644 index 000000000..4bf2076fe --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/FormDefinitionInput.md @@ -0,0 +1,39 @@ +--- +id: v2024-form-definition-input +title: FormDefinitionInput +pagination_label: FormDefinitionInput +sidebar_label: FormDefinitionInput +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormDefinitionInput', 'V2024FormDefinitionInput'] +slug: /tools/sdk/python/v2024/models/form-definition-input +tags: ['SDK', 'Software Development Kit', 'FormDefinitionInput', 'V2024FormDefinitionInput'] +--- + +# FormDefinitionInput + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Unique identifier for the form input. | [optional] +**type** | **Enum** [ 'STRING', 'ARRAY' ] | FormDefinitionInputType value. STRING FormDefinitionInputTypeString | [optional] +**label** | **str** | Name for the form input. | [optional] +**description** | **str** | Form input's description. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.form_definition_input import FormDefinitionInput + +form_definition_input = FormDefinitionInput( +id='00000000-0000-0000-0000-000000000000', +type='STRING', +label='input1', +description='A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/FormDefinitionResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/FormDefinitionResponse.md new file mode 100644 index 000000000..6daf5b52c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/FormDefinitionResponse.md @@ -0,0 +1,93 @@ +--- +id: v2024-form-definition-response +title: FormDefinitionResponse +pagination_label: FormDefinitionResponse +sidebar_label: FormDefinitionResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormDefinitionResponse', 'V2024FormDefinitionResponse'] +slug: /tools/sdk/python/v2024/models/form-definition-response +tags: ['SDK', 'Software Development Kit', 'FormDefinitionResponse', 'V2024FormDefinitionResponse'] +--- + +# FormDefinitionResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Unique guid identifying the form definition. | [optional] +**name** | **str** | Name of the form definition. | [optional] +**description** | **str** | Form definition's description. | [optional] +**owner** | [**FormOwner**](form-owner) | | [optional] +**used_by** | [**[]FormUsedBy**](form-used-by) | List of objects using the form definition. Whenever a system uses a form, the API reaches out to the form service to record that the system is currently using it. | [optional] +**form_input** | [**[]FormDefinitionInput**](form-definition-input) | List of form inputs required to create a form-instance object. | [optional] +**form_elements** | [**[]FormElement**](form-element) | List of nested form elements. | [optional] +**form_conditions** | [**[]FormCondition**](form-condition) | Conditional logic that can dynamically modify the form as the recipient is interacting with it. | [optional] +**created** | **datetime** | Created is the date the form definition was created | [optional] +**modified** | **datetime** | Modified is the last date the form definition was modified | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.form_definition_response import FormDefinitionResponse + +form_definition_response = FormDefinitionResponse( +id='00000000-0000-0000-0000-000000000000', +name='My form', +description='My form description', +owner=sailpoint.v2024.models.form_owner.FormOwner( + type = 'IDENTITY', + id = '2c9180867624cbd7017642d8c8c81f67', + name = 'Grant Smith', ), +used_by=[ + sailpoint.v2024.models.form_used_by.FormUsedBy( + type = 'WORKFLOW', + id = '61940a92-5484-42bc-bc10-b9982b218cdf', + name = 'Access Request Form', ) + ], +form_input=[ + sailpoint.v2024.models.form_definition_input.FormDefinitionInput( + id = '00000000-0000-0000-0000-000000000000', + type = 'STRING', + label = 'input1', + description = 'A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic', ) + ], +form_elements=[ + sailpoint.v2024.models.form_element.FormElement( + id = '00000000-0000-0000-0000-000000000000', + element_type = 'TEXT', + config = {label=Department}, + key = 'department', + validations = [ + sailpoint.v2024.models.form_element_validations_set.FormElementValidationsSet( + validation_type = 'REQUIRED', ) + ], ) + ], +form_conditions=[ + sailpoint.v2024.models.form_condition.FormCondition( + rule_operator = 'AND', + rules = [ + sailpoint.v2024.models.condition_rule.ConditionRule( + source_type = 'ELEMENT', + source = 'department', + operator = 'EQ', + value_type = 'STRING', + value = 'Engineering', ) + ], + effects = [ + sailpoint.v2024.models.condition_effect.ConditionEffect( + effect_type = 'HIDE', + config = sailpoint.v2024.models.condition_effect_config.ConditionEffect_config( + default_value_label = 'Access to Remove', + element = '8110662963316867', ), ) + ], ) + ], +created='2023-07-12T20:14:57.744860Z', +modified='2023-07-12T20:14:57.744860Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/FormDefinitionSelfImportExportDto.md b/docs/tools/sdk/python/Reference/V2024/Models/FormDefinitionSelfImportExportDto.md new file mode 100644 index 000000000..a0529ca9e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/FormDefinitionSelfImportExportDto.md @@ -0,0 +1,38 @@ +--- +id: v2024-form-definition-self-import-export-dto +title: FormDefinitionSelfImportExportDto +pagination_label: FormDefinitionSelfImportExportDto +sidebar_label: FormDefinitionSelfImportExportDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormDefinitionSelfImportExportDto', 'V2024FormDefinitionSelfImportExportDto'] +slug: /tools/sdk/python/v2024/models/form-definition-self-import-export-dto +tags: ['SDK', 'Software Development Kit', 'FormDefinitionSelfImportExportDto', 'V2024FormDefinitionSelfImportExportDto'] +--- + +# FormDefinitionSelfImportExportDto + +Self block for imported/exported object. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'FORM_DEFINITION' ] | Imported/exported object's DTO type. | [optional] +**id** | **str** | Imported/exported object's ID. | [optional] +**name** | **str** | Imported/exported object's display name. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.form_definition_self_import_export_dto import FormDefinitionSelfImportExportDto + +form_definition_self_import_export_dto = FormDefinitionSelfImportExportDto( +type='FORM_DEFINITION', +id='2c9180835d191a86015d28455b4b232a', +name='Temporary User Level Permissions - Requester' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/FormDetails.md b/docs/tools/sdk/python/Reference/V2024/Models/FormDetails.md new file mode 100644 index 000000000..03bb83d15 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/FormDetails.md @@ -0,0 +1,45 @@ +--- +id: v2024-form-details +title: FormDetails +pagination_label: FormDetails +sidebar_label: FormDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormDetails', 'V2024FormDetails'] +slug: /tools/sdk/python/v2024/models/form-details +tags: ['SDK', 'Software Development Kit', 'FormDetails', 'V2024FormDetails'] +--- + +# FormDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the form | [optional] +**name** | **str** | Name of the form | [optional] +**title** | **str** | The form title | [optional] +**subtitle** | **str** | The form subtitle. | [optional] +**target_user** | **str** | The name of the user that should be shown this form | [optional] +**sections** | [**[]SectionDetails**](section-details) | Sections of the form | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.form_details import FormDetails + +form_details = FormDetails( +id='2c9180835d2e5168015d32f890ca1581', +name='AccountSelection Form', +title='Account Selection for John.Doe', +subtitle='Please select from the following', +target_user='Jane.Doe', +sections=[ + sailpoint.v2024.models.section_details.SectionDetails() + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/FormElement.md b/docs/tools/sdk/python/Reference/V2024/Models/FormElement.md new file mode 100644 index 000000000..b630184f2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/FormElement.md @@ -0,0 +1,44 @@ +--- +id: v2024-form-element +title: FormElement +pagination_label: FormElement +sidebar_label: FormElement +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormElement', 'V2024FormElement'] +slug: /tools/sdk/python/v2024/models/form-element +tags: ['SDK', 'Software Development Kit', 'FormElement', 'V2024FormElement'] +--- + +# FormElement + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Form element identifier. | [optional] +**element_type** | **Enum** [ 'TEXT', 'TOGGLE', 'TEXTAREA', 'HIDDEN', 'PHONE', 'EMAIL', 'SELECT', 'DATE', 'SECTION', 'COLUMN_SET', 'IMAGE', 'DESCRIPTION' ] | FormElementType value. TEXT FormElementTypeText TOGGLE FormElementTypeToggle TEXTAREA FormElementTypeTextArea HIDDEN FormElementTypeHidden PHONE FormElementTypePhone EMAIL FormElementTypeEmail SELECT FormElementTypeSelect DATE FormElementTypeDate SECTION FormElementTypeSection COLUMN_SET FormElementTypeColumns IMAGE FormElementTypeImage DESCRIPTION FormElementTypeDescription | [optional] +**config** | **map[string]object** | Config object. | [optional] +**key** | **str** | Technical key. | [optional] +**validations** | [**[]FormElementValidationsSet**](form-element-validations-set) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.form_element import FormElement + +form_element = FormElement( +id='00000000-0000-0000-0000-000000000000', +element_type='TEXT', +config={label=Department}, +key='department', +validations=[ + sailpoint.v2024.models.form_element_validations_set.FormElementValidationsSet( + validation_type = 'REQUIRED', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/FormElementDataSourceConfigOptions.md b/docs/tools/sdk/python/Reference/V2024/Models/FormElementDataSourceConfigOptions.md new file mode 100644 index 000000000..48eea1abe --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/FormElementDataSourceConfigOptions.md @@ -0,0 +1,37 @@ +--- +id: v2024-form-element-data-source-config-options +title: FormElementDataSourceConfigOptions +pagination_label: FormElementDataSourceConfigOptions +sidebar_label: FormElementDataSourceConfigOptions +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormElementDataSourceConfigOptions', 'V2024FormElementDataSourceConfigOptions'] +slug: /tools/sdk/python/v2024/models/form-element-data-source-config-options +tags: ['SDK', 'Software Development Kit', 'FormElementDataSourceConfigOptions', 'V2024FormElementDataSourceConfigOptions'] +--- + +# FormElementDataSourceConfigOptions + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**label** | **str** | Label is the main label to display to the user when selecting this option | [optional] +**sub_label** | **str** | SubLabel is the sub label to display below the label in diminutive styling to help describe or identify this option | [optional] +**value** | **str** | Value is the value to save as an entry when the user selects this option | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.form_element_data_source_config_options import FormElementDataSourceConfigOptions + +form_element_data_source_config_options = FormElementDataSourceConfigOptions( +label='regression-test-access-request-07c55dd6-3056-430a-86b5-fccc395bb6c5', +sub_label='', +value='e96674448eba4ca1ba04eee999a8f3cd' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/FormElementDynamicDataSource.md b/docs/tools/sdk/python/Reference/V2024/Models/FormElementDynamicDataSource.md new file mode 100644 index 000000000..90c1216fb --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/FormElementDynamicDataSource.md @@ -0,0 +1,39 @@ +--- +id: v2024-form-element-dynamic-data-source +title: FormElementDynamicDataSource +pagination_label: FormElementDynamicDataSource +sidebar_label: FormElementDynamicDataSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormElementDynamicDataSource', 'V2024FormElementDynamicDataSource'] +slug: /tools/sdk/python/v2024/models/form-element-dynamic-data-source +tags: ['SDK', 'Software Development Kit', 'FormElementDynamicDataSource', 'V2024FormElementDynamicDataSource'] +--- + +# FormElementDynamicDataSource + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**config** | [**FormElementDynamicDataSourceConfig**](form-element-dynamic-data-source-config) | | [optional] +**data_source_type** | **Enum** [ 'STATIC', 'INTERNAL', 'SEARCH', 'FORM_INPUT' ] | DataSourceType is a FormElementDataSourceType value STATIC FormElementDataSourceTypeStatic INTERNAL FormElementDataSourceTypeInternal SEARCH FormElementDataSourceTypeSearch FORM_INPUT FormElementDataSourceTypeFormInput | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.form_element_dynamic_data_source import FormElementDynamicDataSource + +form_element_dynamic_data_source = FormElementDynamicDataSource( +config=sailpoint.v2024.models.form_element_dynamic_data_source_config.FormElementDynamicDataSourceConfig( + aggregation_bucket_field = 'attributes.cloudStatus.exact', + indices = [identities], + object_type = 'IDENTITY', + query = '*', ), +data_source_type='STATIC' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/FormElementDynamicDataSourceConfig.md b/docs/tools/sdk/python/Reference/V2024/Models/FormElementDynamicDataSourceConfig.md new file mode 100644 index 000000000..3280f14b4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/FormElementDynamicDataSourceConfig.md @@ -0,0 +1,39 @@ +--- +id: v2024-form-element-dynamic-data-source-config +title: FormElementDynamicDataSourceConfig +pagination_label: FormElementDynamicDataSourceConfig +sidebar_label: FormElementDynamicDataSourceConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormElementDynamicDataSourceConfig', 'V2024FormElementDynamicDataSourceConfig'] +slug: /tools/sdk/python/v2024/models/form-element-dynamic-data-source-config +tags: ['SDK', 'Software Development Kit', 'FormElementDynamicDataSourceConfig', 'V2024FormElementDynamicDataSourceConfig'] +--- + +# FormElementDynamicDataSourceConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**aggregation_bucket_field** | **str** | AggregationBucketField is the aggregation bucket field name | [optional] +**indices** | **[]str** | Indices is a list of indices to use | [optional] +**object_type** | **Enum** [ 'IDENTITY', 'ACCESS_PROFILE', 'SOURCES', 'ROLE', 'ENTITLEMENT' ] | ObjectType is a PreDefinedSelectOption value IDENTITY PreDefinedSelectOptionIdentity ACCESS_PROFILE PreDefinedSelectOptionAccessProfile SOURCES PreDefinedSelectOptionSources ROLE PreDefinedSelectOptionRole ENTITLEMENT PreDefinedSelectOptionEntitlement | [optional] +**query** | **str** | Query is a text | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.form_element_dynamic_data_source_config import FormElementDynamicDataSourceConfig + +form_element_dynamic_data_source_config = FormElementDynamicDataSourceConfig( +aggregation_bucket_field='attributes.cloudStatus.exact', +indices=[identities], +object_type='IDENTITY', +query='*' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/FormElementPreviewRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/FormElementPreviewRequest.md new file mode 100644 index 000000000..4b4f1a59c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/FormElementPreviewRequest.md @@ -0,0 +1,39 @@ +--- +id: v2024-form-element-preview-request +title: FormElementPreviewRequest +pagination_label: FormElementPreviewRequest +sidebar_label: FormElementPreviewRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormElementPreviewRequest', 'V2024FormElementPreviewRequest'] +slug: /tools/sdk/python/v2024/models/form-element-preview-request +tags: ['SDK', 'Software Development Kit', 'FormElementPreviewRequest', 'V2024FormElementPreviewRequest'] +--- + +# FormElementPreviewRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data_source** | [**FormElementDynamicDataSource**](form-element-dynamic-data-source) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.form_element_preview_request import FormElementPreviewRequest + +form_element_preview_request = FormElementPreviewRequest( +data_source=sailpoint.v2024.models.form_element_dynamic_data_source.FormElementDynamicDataSource( + config = sailpoint.v2024.models.form_element_dynamic_data_source_config.FormElementDynamicDataSourceConfig( + aggregation_bucket_field = 'attributes.cloudStatus.exact', + indices = [identities], + object_type = 'IDENTITY', + query = '*', ), + data_source_type = 'STATIC', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/FormElementValidationsSet.md b/docs/tools/sdk/python/Reference/V2024/Models/FormElementValidationsSet.md new file mode 100644 index 000000000..77015bdf7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/FormElementValidationsSet.md @@ -0,0 +1,34 @@ +--- +id: v2024-form-element-validations-set +title: FormElementValidationsSet +pagination_label: FormElementValidationsSet +sidebar_label: FormElementValidationsSet +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormElementValidationsSet', 'V2024FormElementValidationsSet'] +slug: /tools/sdk/python/v2024/models/form-element-validations-set +tags: ['SDK', 'Software Development Kit', 'FormElementValidationsSet', 'V2024FormElementValidationsSet'] +--- + +# FormElementValidationsSet + +Set of FormElementValidation items. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**validation_type** | **Enum** [ 'REQUIRED', 'MIN_LENGTH', 'MAX_LENGTH', 'REGEX', 'DATE', 'MAX_DATE', 'MIN_DATE', 'LESS_THAN_DATE', 'PHONE', 'EMAIL', 'DATA_SOURCE', 'TEXTAREA' ] | The type of data validation that you wish to enforce, e.g., a required field, a minimum length, etc. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.form_element_validations_set import FormElementValidationsSet + +form_element_validations_set = FormElementValidationsSet( +validation_type='REQUIRED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/FormError.md b/docs/tools/sdk/python/Reference/V2024/Models/FormError.md new file mode 100644 index 000000000..c9ea95310 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/FormError.md @@ -0,0 +1,42 @@ +--- +id: v2024-form-error +title: FormError +pagination_label: FormError +sidebar_label: FormError +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormError', 'V2024FormError'] +slug: /tools/sdk/python/v2024/models/form-error +tags: ['SDK', 'Software Development Kit', 'FormError', 'V2024FormError'] +--- + +# FormError + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | Key is the technical key | [optional] +**messages** | [**[]ErrorMessage**](error-message) | Messages is a list of web.ErrorMessage items | [optional] +**value** | **object** | Value is the value associated with a Key | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.form_error import FormError + +form_error = FormError( +key='department', +messages=[ + sailpoint.v2024.models.error_message_is_the_standard_api_error_response_message_type/.ErrorMessage is the standard API error response message type.( + locale = 'en-US', + locale_origin = 'DEFAULT', + text = 'This is an error', ) + ], +value=Engineering +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/FormInstanceCreatedBy.md b/docs/tools/sdk/python/Reference/V2024/Models/FormInstanceCreatedBy.md new file mode 100644 index 000000000..66539d10b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/FormInstanceCreatedBy.md @@ -0,0 +1,35 @@ +--- +id: v2024-form-instance-created-by +title: FormInstanceCreatedBy +pagination_label: FormInstanceCreatedBy +sidebar_label: FormInstanceCreatedBy +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormInstanceCreatedBy', 'V2024FormInstanceCreatedBy'] +slug: /tools/sdk/python/v2024/models/form-instance-created-by +tags: ['SDK', 'Software Development Kit', 'FormInstanceCreatedBy', 'V2024FormInstanceCreatedBy'] +--- + +# FormInstanceCreatedBy + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID is a unique identifier | [optional] +**type** | **Enum** [ 'WORKFLOW_EXECUTION', 'SOURCE' ] | Type is a form instance created by type enum value WORKFLOW_EXECUTION FormInstanceCreatedByTypeWorkflowExecution SOURCE FormInstanceCreatedByTypeSource | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.form_instance_created_by import FormInstanceCreatedBy + +form_instance_created_by = FormInstanceCreatedBy( +id='00000000-0000-0000-0000-000000000000', +type='WORKFLOW_EXECUTION' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/FormInstanceRecipient.md b/docs/tools/sdk/python/Reference/V2024/Models/FormInstanceRecipient.md new file mode 100644 index 000000000..da54d8b7b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/FormInstanceRecipient.md @@ -0,0 +1,35 @@ +--- +id: v2024-form-instance-recipient +title: FormInstanceRecipient +pagination_label: FormInstanceRecipient +sidebar_label: FormInstanceRecipient +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormInstanceRecipient', 'V2024FormInstanceRecipient'] +slug: /tools/sdk/python/v2024/models/form-instance-recipient +tags: ['SDK', 'Software Development Kit', 'FormInstanceRecipient', 'V2024FormInstanceRecipient'] +--- + +# FormInstanceRecipient + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID is a unique identifier | [optional] +**type** | **Enum** [ 'IDENTITY' ] | Type is a FormInstanceRecipientType value IDENTITY FormInstanceRecipientIdentity | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.form_instance_recipient import FormInstanceRecipient + +form_instance_recipient = FormInstanceRecipient( +id='00000000-0000-0000-0000-000000000000', +type='IDENTITY' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/FormInstanceResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/FormInstanceResponse.md new file mode 100644 index 000000000..76bee8b7a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/FormInstanceResponse.md @@ -0,0 +1,105 @@ +--- +id: v2024-form-instance-response +title: FormInstanceResponse +pagination_label: FormInstanceResponse +sidebar_label: FormInstanceResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormInstanceResponse', 'V2024FormInstanceResponse'] +slug: /tools/sdk/python/v2024/models/form-instance-response +tags: ['SDK', 'Software Development Kit', 'FormInstanceResponse', 'V2024FormInstanceResponse'] +--- + +# FormInstanceResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | Created is the date the form instance was assigned | [optional] +**created_by** | [**FormInstanceCreatedBy**](form-instance-created-by) | | [optional] +**expire** | **str** | Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record | [optional] +**form_conditions** | [**[]FormCondition**](form-condition) | FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form | [optional] +**form_data** | **map[string]object** | FormData is the data provided by the form on submit. The data is in a key -> value map | [optional] +**form_definition_id** | **str** | FormDefinitionID is the id of the form definition that created this form | [optional] +**form_elements** | [**[]FormElement**](form-element) | FormElements is the configuration of the form, this would be a repeat of the fields from the form-config | [optional] +**form_errors** | [**[]FormError**](form-error) | FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors | [optional] +**form_input** | **map[string]object** | FormInput is an object of form input labels to value | [optional] +**id** | **str** | Unique guid identifying this form instance | [optional] +**modified** | **datetime** | Modified is the last date the form instance was modified | [optional] +**recipients** | [**[]FormInstanceRecipient**](form-instance-recipient) | Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it | [optional] +**stand_alone_form** | **bool** | StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form | [optional] [default to False] +**stand_alone_form_url** | **str** | StandAloneFormURL is the URL where this form may be completed by the designated recipients using the standalone form UI | [optional] +**state** | **Enum** [ 'ASSIGNED', 'IN_PROGRESS', 'SUBMITTED', 'COMPLETED', 'CANCELLED' ] | State the state of the form instance ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.form_instance_response import FormInstanceResponse + +form_instance_response = FormInstanceResponse( +created='2023-07-12T20:14:57.744860Z', +created_by=sailpoint.v2024.models.form_instance_created_by.FormInstanceCreatedBy( + id = '00000000-0000-0000-0000-000000000000', + type = 'WORKFLOW_EXECUTION', ), +expire='2023-08-12T20:14:57.74486Z', +form_conditions=[ + sailpoint.v2024.models.form_condition.FormCondition( + rule_operator = 'AND', + rules = [ + sailpoint.v2024.models.condition_rule.ConditionRule( + source_type = 'ELEMENT', + source = 'department', + operator = 'EQ', + value_type = 'STRING', + value = 'Engineering', ) + ], + effects = [ + sailpoint.v2024.models.condition_effect.ConditionEffect( + effect_type = 'HIDE', + config = sailpoint.v2024.models.condition_effect_config.ConditionEffect_config( + default_value_label = 'Access to Remove', + element = '8110662963316867', ), ) + ], ) + ], +form_data={department=Engineering}, +form_definition_id='49841cb8-00a5-4fbd-9888-8bbb28d48331', +form_elements=[ + sailpoint.v2024.models.form_element.FormElement( + id = '00000000-0000-0000-0000-000000000000', + element_type = 'TEXT', + config = {label=Department}, + key = 'department', + validations = [ + sailpoint.v2024.models.form_element_validations_set.FormElementValidationsSet( + validation_type = 'REQUIRED', ) + ], ) + ], +form_errors=[ + sailpoint.v2024.models.form_error.FormError( + key = 'department', + messages = [ + sailpoint.v2024.models.error_message_is_the_standard_api_error_response_message_type/.ErrorMessage is the standard API error response message type.( + locale = 'en-US', + locale_origin = 'DEFAULT', + text = 'This is an error', ) + ], + value = Engineering, ) + ], +form_input={input1=Sales}, +id='06a2d961-07fa-44d1-8d0a-2f6470e30fd2', +modified='2023-07-12T20:14:57.744860Z', +recipients=[ + sailpoint.v2024.models.form_instance_recipient.FormInstanceRecipient( + id = '00000000-0000-0000-0000-000000000000', + type = 'IDENTITY', ) + ], +stand_alone_form=False, +stand_alone_form_url='https://my-org.identitynow.com/ui/d/forms/00000000-0000-0000-0000-000000000000', +state='ASSIGNED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/FormItemDetails.md b/docs/tools/sdk/python/Reference/V2024/Models/FormItemDetails.md new file mode 100644 index 000000000..8b82b35c0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/FormItemDetails.md @@ -0,0 +1,33 @@ +--- +id: v2024-form-item-details +title: FormItemDetails +pagination_label: FormItemDetails +sidebar_label: FormItemDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormItemDetails', 'V2024FormItemDetails'] +slug: /tools/sdk/python/v2024/models/form-item-details +tags: ['SDK', 'Software Development Kit', 'FormItemDetails', 'V2024FormItemDetails'] +--- + +# FormItemDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the FormItem | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.form_item_details import FormItemDetails + +form_item_details = FormItemDetails( +name='Field1' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/FormOwner.md b/docs/tools/sdk/python/Reference/V2024/Models/FormOwner.md new file mode 100644 index 000000000..dcb494738 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/FormOwner.md @@ -0,0 +1,37 @@ +--- +id: v2024-form-owner +title: FormOwner +pagination_label: FormOwner +sidebar_label: FormOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormOwner', 'V2024FormOwner'] +slug: /tools/sdk/python/v2024/models/form-owner +tags: ['SDK', 'Software Development Kit', 'FormOwner', 'V2024FormOwner'] +--- + +# FormOwner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | FormOwnerType value. IDENTITY FormOwnerTypeIdentity | [optional] +**id** | **str** | Unique identifier of the form's owner. | [optional] +**name** | **str** | Name of the form's owner. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.form_owner import FormOwner + +form_owner = FormOwner( +type='IDENTITY', +id='2c9180867624cbd7017642d8c8c81f67', +name='Grant Smith' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/FormUsedBy.md b/docs/tools/sdk/python/Reference/V2024/Models/FormUsedBy.md new file mode 100644 index 000000000..2f2474f1c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/FormUsedBy.md @@ -0,0 +1,37 @@ +--- +id: v2024-form-used-by +title: FormUsedBy +pagination_label: FormUsedBy +sidebar_label: FormUsedBy +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormUsedBy', 'V2024FormUsedBy'] +slug: /tools/sdk/python/v2024/models/form-used-by +tags: ['SDK', 'Software Development Kit', 'FormUsedBy', 'V2024FormUsedBy'] +--- + +# FormUsedBy + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'WORKFLOW', 'SOURCE', 'MySailPoint' ] | FormUsedByType value. WORKFLOW FormUsedByTypeWorkflow SOURCE FormUsedByTypeSource MySailPoint FormUsedByType | [optional] +**id** | **str** | Unique identifier of the system using the form. | [optional] +**name** | **str** | Name of the system using the form. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.form_used_by import FormUsedBy + +form_used_by = FormUsedBy( +type='WORKFLOW', +id='61940a92-5484-42bc-bc10-b9982b218cdf', +name='Access Request Form' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ForwardApprovalDto.md b/docs/tools/sdk/python/Reference/V2024/Models/ForwardApprovalDto.md new file mode 100644 index 000000000..cc40bfcda --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ForwardApprovalDto.md @@ -0,0 +1,35 @@ +--- +id: v2024-forward-approval-dto +title: ForwardApprovalDto +pagination_label: ForwardApprovalDto +sidebar_label: ForwardApprovalDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ForwardApprovalDto', 'V2024ForwardApprovalDto'] +slug: /tools/sdk/python/v2024/models/forward-approval-dto +tags: ['SDK', 'Software Development Kit', 'ForwardApprovalDto', 'V2024ForwardApprovalDto'] +--- + +# ForwardApprovalDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**new_owner_id** | **str** | The Id of the new owner | [required] +**comment** | **str** | The comment provided by the forwarder | [required] +} + +## Example + +```python +from sailpoint.v2024.models.forward_approval_dto import ForwardApprovalDto + +forward_approval_dto = ForwardApprovalDto( +new_owner_id='2c91808568c529c60168cca6f90c1314', +comment='2c91808568c529c60168cca6f90c1313' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/FullDiscoveredApplications.md b/docs/tools/sdk/python/Reference/V2024/Models/FullDiscoveredApplications.md new file mode 100644 index 000000000..e28aa0398 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/FullDiscoveredApplications.md @@ -0,0 +1,52 @@ +--- +id: v2024-full-discovered-applications +title: FullDiscoveredApplications +pagination_label: FullDiscoveredApplications +sidebar_label: FullDiscoveredApplications +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FullDiscoveredApplications', 'V2024FullDiscoveredApplications'] +slug: /tools/sdk/python/v2024/models/full-discovered-applications +tags: ['SDK', 'Software Development Kit', 'FullDiscoveredApplications', 'V2024FullDiscoveredApplications'] +--- + +# FullDiscoveredApplications + +Discovered applications with their respective associated sources + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Unique identifier for the discovered application. | [optional] +**name** | **str** | Name of the discovered application. | [optional] +**discovery_source** | **str** | Source from which the application was discovered. | [optional] +**discovered_vendor** | **str** | The vendor associated with the discovered application. | [optional] +**description** | **str** | A brief description of the discovered application. | [optional] +**recommended_connectors** | **[]str** | List of recommended connectors for the application. | [optional] +**discovered_at** | **datetime** | The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. | [optional] +**created_at** | **datetime** | The timestamp when the application was first discovered, in ISO 8601 format. | [optional] +**status** | **str** | The status of an application within the discovery source. By default this field is set to \"ACTIVE\" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to \"INACTIVE\". | [optional] +**associated_sources** | **[]str** | List of associated sources related to this discovered application. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.full_discovered_applications import FullDiscoveredApplications + +full_discovered_applications = FullDiscoveredApplications( +id='', +name='ExampleApp', +discovery_source='csv', +discovered_vendor='ExampleVendor', +description='An application for managing examples.', +recommended_connectors=[ConnectorA, ConnectorB], +discovered_at='2023-01-01T12:00Z', +created_at='2023-01-01T12:00Z', +status='ACTIVE', +associated_sources=[e0cc5d7d-bf7f-4f81-b2af-8885b09d9923, a0303682-5e4a-44f7-bdc2-6ce6112549c1] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/GetActiveCampaigns200ResponseInner.md b/docs/tools/sdk/python/Reference/V2024/Models/GetActiveCampaigns200ResponseInner.md new file mode 100644 index 000000000..df8835e83 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/GetActiveCampaigns200ResponseInner.md @@ -0,0 +1,123 @@ +--- +id: v2024-get-active-campaigns200-response-inner +title: GetActiveCampaigns200ResponseInner +pagination_label: GetActiveCampaigns200ResponseInner +sidebar_label: GetActiveCampaigns200ResponseInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'GetActiveCampaigns200ResponseInner', 'V2024GetActiveCampaigns200ResponseInner'] +slug: /tools/sdk/python/v2024/models/get-active-campaigns200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetActiveCampaigns200ResponseInner', 'V2024GetActiveCampaigns200ResponseInner'] +--- + +# GetActiveCampaigns200ResponseInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the campaign | [optional] [readonly] +**name** | **str** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**description** | **str** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**deadline** | **datetime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] +**type** | **Enum** [ 'MANAGER', 'SOURCE_OWNER', 'SEARCH', 'ROLE_COMPOSITION', 'MACHINE_ACCOUNT' ] | The type of campaign. Could be extended in the future. | [required] +**email_notification_enabled** | **bool** | Enables email notification for this campaign | [optional] [default to False] +**auto_revoke_allowed** | **bool** | Allows auto revoke for this campaign | [optional] [default to False] +**recommendations_enabled** | **bool** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to False] +**status** | **Enum** [ 'PENDING', 'STAGED', 'CANCELING', 'ACTIVATING', 'ACTIVE', 'COMPLETING', 'COMPLETED', 'ERROR', 'ARCHIVED' ] | The campaign's current status. | [optional] [readonly] +**correlated_status** | **Enum** [ 'CORRELATED', 'UNCORRELATED' ] | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] +**created** | **datetime** | Created time of the campaign | [optional] [readonly] +**total_certifications** | **int** | The total number of certifications in this campaign. | [optional] [readonly] +**completed_certifications** | **int** | The number of completed certifications in this campaign. | [optional] [readonly] +**alerts** | [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] +**modified** | **datetime** | Modified time of the campaign | [optional] [readonly] +**filter** | [**CampaignAllOfFilter**](campaign-all-of-filter) | | [optional] +**sunset_comments_required** | **bool** | Determines if comments on sunset date changes are required. | [optional] [default to True] +**source_owner_campaign_info** | [**CampaignAllOfSourceOwnerCampaignInfo**](campaign-all-of-source-owner-campaign-info) | | [optional] +**search_campaign_info** | [**CampaignAllOfSearchCampaignInfo**](campaign-all-of-search-campaign-info) | | [optional] +**role_composition_campaign_info** | [**CampaignAllOfRoleCompositionCampaignInfo**](campaign-all-of-role-composition-campaign-info) | | [optional] +**machine_account_campaign_info** | [**CampaignAllOfMachineAccountCampaignInfo**](campaign-all-of-machine-account-campaign-info) | | [optional] +**sources_with_orphan_entitlements** | [**[]CampaignAllOfSourcesWithOrphanEntitlements**](campaign-all-of-sources-with-orphan-entitlements) | A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [optional] [readonly] +**mandatory_comment_requirement** | **Enum** [ 'ALL_DECISIONS', 'REVOKE_ONLY_DECISIONS', 'NO_DECISIONS' ] | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner + +get_active_campaigns200_response_inner = GetActiveCampaigns200ResponseInner( +id='2c9079b270a266a60170a2779fcb0007', +name='Manager Campaign', +description='Everyone needs to be reviewed by their manager', +deadline='2020-03-15T10:00:01.456Z', +type='MANAGER', +email_notification_enabled=False, +auto_revoke_allowed=False, +recommendations_enabled=True, +status='ACTIVE', +correlated_status='CORRELATED', +created='2020-03-03T22:15:13.611Z', +total_certifications=100, +completed_certifications=10, +alerts=[ + sailpoint.v2024.models.campaign_alert.CampaignAlert( + level = 'ERROR', + localizations = [ + sailpoint.v2024.models.error_message_dto.ErrorMessageDto( + locale = 'en-US', + locale_origin = 'DEFAULT', + text = 'The request was syntactically correct but its content is semantically invalid.', ) + ], ) + ], +modified='2020-03-03T22:20:12.674Z', +filter=sailpoint.v2024.models.campaign_all_of_filter.Campaign_allOf_filter( + id = '0fbe863c063c4c88a35fd7f17e8a3df5', + type = 'CAMPAIGN_FILTER', + name = 'Test Filter', ), +sunset_comments_required=True, +source_owner_campaign_info=sailpoint.v2024.models.campaign_all_of_source_owner_campaign_info.Campaign_allOf_sourceOwnerCampaignInfo( + source_ids = [0fbe863c063c4c88a35fd7f17e8a3df5], ), +search_campaign_info=sailpoint.v2024.models.campaign_all_of_search_campaign_info.Campaign_allOf_searchCampaignInfo( + type = 'ACCESS', + description = 'Search Campaign description', + reviewer = sailpoint.v2024.models.campaign_all_of_search_campaign_info_reviewer.Campaign_allOf_searchCampaignInfo_reviewer( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), + query = 'Search Campaign query description', + identity_ids = [0fbe863c063c4c88a35fd7f17e8a3df5], + access_constraints = [ + sailpoint.v2024.models.access_constraint.AccessConstraint( + type = 'ENTITLEMENT', + ids = [2c90ad2a70ace7d50170acf22ca90010], + operator = 'SELECTED', ) + ], ), +role_composition_campaign_info=sailpoint.v2024.models.campaign_all_of_role_composition_campaign_info.Campaign_allOf_roleCompositionCampaignInfo( + reviewer_id = '2c91808568c529c60168cca6f90c1313', + reviewer = sailpoint.v2024.models.campaign_all_of_role_composition_campaign_info_reviewer.Campaign_allOf_roleCompositionCampaignInfo_reviewer( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), + role_ids = [2c90ad2a70ace7d50170acf22ca90010], + remediator_ref = sailpoint.v2024.models.campaign_all_of_role_composition_campaign_info_remediator_ref.Campaign_allOf_roleCompositionCampaignInfo_remediatorRef( + type = 'IDENTITY', + id = '2c90ad2a70ace7d50170acf22ca90010', + name = 'Role Admin', ), + query = 'Search Query', + description = 'Role Composition Description', ), +machine_account_campaign_info=sailpoint.v2024.models.campaign_all_of_machine_account_campaign_info.Campaign_allOf_machineAccountCampaignInfo( + source_ids = [0fbe863c063c4c88a35fd7f17e8a3df5], + reviewer_type = 'ACCOUNT_OWNER', ), +sources_with_orphan_entitlements=[ + sailpoint.v2024.models.campaign_all_of_sources_with_orphan_entitlements.Campaign_allOf_sourcesWithOrphanEntitlements( + id = '2c90ad2a70ace7d50170acf22ca90010', + type = 'SOURCE', + name = 'Source with orphan entitlements', ) + ], +mandatory_comment_requirement='NO_DECISIONS' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/GetDiscoveredApplications200ResponseInner.md b/docs/tools/sdk/python/Reference/V2024/Models/GetDiscoveredApplications200ResponseInner.md new file mode 100644 index 000000000..97a1ad3f0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/GetDiscoveredApplications200ResponseInner.md @@ -0,0 +1,51 @@ +--- +id: v2024-get-discovered-applications200-response-inner +title: GetDiscoveredApplications200ResponseInner +pagination_label: GetDiscoveredApplications200ResponseInner +sidebar_label: GetDiscoveredApplications200ResponseInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'GetDiscoveredApplications200ResponseInner', 'V2024GetDiscoveredApplications200ResponseInner'] +slug: /tools/sdk/python/v2024/models/get-discovered-applications200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetDiscoveredApplications200ResponseInner', 'V2024GetDiscoveredApplications200ResponseInner'] +--- + +# GetDiscoveredApplications200ResponseInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Unique identifier for the discovered application. | [optional] +**name** | **str** | Name of the discovered application. | [optional] +**discovery_source** | **str** | Source from which the application was discovered. | [optional] +**discovered_vendor** | **str** | The vendor associated with the discovered application. | [optional] +**description** | **str** | A brief description of the discovered application. | [optional] +**recommended_connectors** | **[]str** | List of recommended connectors for the application. | [optional] +**discovered_at** | **datetime** | The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. | [optional] +**created_at** | **datetime** | The timestamp when the application was first discovered, in ISO 8601 format. | [optional] +**status** | **str** | The status of an application within the discovery source. By default this field is set to \"ACTIVE\" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to \"INACTIVE\". | [optional] +**associated_sources** | **[]str** | List of associated sources related to this discovered application. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.get_discovered_applications200_response_inner import GetDiscoveredApplications200ResponseInner + +get_discovered_applications200_response_inner = GetDiscoveredApplications200ResponseInner( +id='', +name='ExampleApp', +discovery_source='csv', +discovered_vendor='ExampleVendor', +description='An application for managing examples.', +recommended_connectors=[ConnectorA, ConnectorB], +discovered_at='2023-01-01T12:00Z', +created_at='2023-01-01T12:00Z', +status='ACTIVE', +associated_sources=[e0cc5d7d-bf7f-4f81-b2af-8885b09d9923, a0303682-5e4a-44f7-bdc2-6ce6112549c1] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/GetHistoricalIdentityEvents200ResponseInner.md b/docs/tools/sdk/python/Reference/V2024/Models/GetHistoricalIdentityEvents200ResponseInner.md new file mode 100644 index 000000000..358e05d76 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/GetHistoricalIdentityEvents200ResponseInner.md @@ -0,0 +1,86 @@ +--- +id: v2024-get-historical-identity-events200-response-inner +title: GetHistoricalIdentityEvents200ResponseInner +pagination_label: GetHistoricalIdentityEvents200ResponseInner +sidebar_label: GetHistoricalIdentityEvents200ResponseInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'GetHistoricalIdentityEvents200ResponseInner', 'V2024GetHistoricalIdentityEvents200ResponseInner'] +slug: /tools/sdk/python/v2024/models/get-historical-identity-events200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetHistoricalIdentityEvents200ResponseInner', 'V2024GetHistoricalIdentityEvents200ResponseInner'] +--- + +# GetHistoricalIdentityEvents200ResponseInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_item** | [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional] +**identity_id** | **str** | the identity id | [optional] +**event_type** | **str** | the event type | [optional] +**dt** | **str** | the date of event | [optional] +**governance_event** | [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional] +**changes** | [**[]AttributeChange**](attribute-change) | | [optional] +**access_request** | [**AccessRequestResponse1**](access-request-response1) | | [optional] +**certification_id** | **str** | the id of the certification item | [optional] +**certification_name** | **str** | the certification item name | [optional] +**signed_date** | **str** | the date ceritification was signed | [optional] +**certifiers** | [**[]CertifierResponse**](certifier-response) | this field is deprecated and may go away | [optional] +**reviewers** | [**[]CertifierResponse**](certifier-response) | The list of identities who review this certification | [optional] +**signer** | [**CertifierResponse**](certifier-response) | | [optional] +**account** | [**AccountStatusChangedAccount**](account-status-changed-account) | | [optional] +**status_change** | [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.get_historical_identity_events200_response_inner import GetHistoricalIdentityEvents200ResponseInner + +get_historical_identity_events200_response_inner = GetHistoricalIdentityEvents200ResponseInner( +access_item={id=8c190e6787aa4ed9a90bd9d5344523fb, accessType=account, nativeIdentity=127999, sourceName=JDBC Entitlements Source, entitlementCount=0, displayName=Sample Name}, +identity_id='', +event_type='', +dt='', +governance_event=sailpoint.v2024.models.correlated_governance_event.CorrelatedGovernanceEvent( + name = 'Manager Certification for Jon Snow', + dt = '2019-03-08T22:37:33.901Z', + type = 'certification', + governance_id = '2c91808a77ff216301782327a50f09bf', + owners = [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}], + reviewers = [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}], + decision_maker = sailpoint.v2024.models.certifier_response.CertifierResponse( + id = '8a80828f643d484f01643e14202e206f', + display_name = 'John Snow', ), ), +changes=[ + {name=firstname, previousValue=adam, newValue=zampa} + ], +access_request=sailpoint.v2024.models.access_request_response_1.AccessRequestResponse_1( + requester_id = '2c91808a77ff216301782327a50f09bf', + requester_name = 'Bing C', + items = [{operation=Add, accessItemType=role, name=Role-1, decision=APPROVED, description=The role descrition, sourceId=8a80828f643d484f01643e14202e206f, sourceName=Source1, approvalInfos=[{name=John Snow, id=8a80828f643d484f01643e14202e2000, status=Approved}]}], ), +certification_id='2c91808a77ff216301782327a50f09bf', +certification_name='Cert name', +signed_date='2019-03-08T22:37:33.901Z', +certifiers=[{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}], +reviewers=[{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}], +signer=sailpoint.v2024.models.certifier_response.CertifierResponse( + id = '8a80828f643d484f01643e14202e206f', + display_name = 'John Snow', ), +account=sailpoint.v2024.models.account_status_changed_account.AccountStatusChanged_account( + id = '', + native_identity = '', + display_name = '', + source_id = '', + source_name = '', + entitlement_count = 56, + access_type = '', ), +status_change=sailpoint.v2024.models.account_status_changed_status_change.AccountStatusChanged_statusChange( + previous_status = 'enabled', + new_status = 'enabled', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/GetOAuthClientResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/GetOAuthClientResponse.md new file mode 100644 index 000000000..9632491b0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/GetOAuthClientResponse.md @@ -0,0 +1,73 @@ +--- +id: v2024-get-o-auth-client-response +title: GetOAuthClientResponse +pagination_label: GetOAuthClientResponse +sidebar_label: GetOAuthClientResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'GetOAuthClientResponse', 'V2024GetOAuthClientResponse'] +slug: /tools/sdk/python/v2024/models/get-o-auth-client-response +tags: ['SDK', 'Software Development Kit', 'GetOAuthClientResponse', 'V2024GetOAuthClientResponse'] +--- + +# GetOAuthClientResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the OAuth client | [required] +**business_name** | **str** | The name of the business the API Client should belong to | [required] +**homepage_url** | **str** | The homepage URL associated with the owner of the API Client | [required] +**name** | **str** | A human-readable name for the API Client | [required] +**description** | **str** | A description of the API Client | [required] +**access_token_validity_seconds** | **int** | The number of seconds an access token generated for this API Client is valid for | [required] +**refresh_token_validity_seconds** | **int** | The number of seconds a refresh token generated for this API Client is valid for | [required] +**redirect_uris** | **[]str** | A list of the approved redirect URIs used with the authorization_code flow | [required] +**grant_types** | [**[]GrantType**](grant-type) | A list of OAuth 2.0 grant types this API Client can be used with | [required] +**access_type** | [**AccessType**](access-type) | | [required] +**type** | [**ClientType**](client-type) | | [required] +**internal** | **bool** | An indicator of whether the API Client can be used for requests internal to IDN | [required] +**enabled** | **bool** | An indicator of whether the API Client is enabled for use | [required] +**strong_auth_supported** | **bool** | An indicator of whether the API Client supports strong authentication | [required] +**claims_supported** | **bool** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | [required] +**created** | **datetime** | The date and time, down to the millisecond, when the API Client was created | [required] +**modified** | **datetime** | The date and time, down to the millisecond, when the API Client was last updated | [required] +**secret** | **str** | | [optional] +**metadata** | **str** | | [optional] +**last_used** | **datetime** | The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed. | [optional] +**scope** | **[]str** | Scopes of the API Client. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.get_o_auth_client_response import GetOAuthClientResponse + +get_o_auth_client_response = GetOAuthClientResponse( +id='2c9180835d2e5168015d32f890ca1581', +business_name='Acme-Solar', +homepage_url='http://localhost:12345', +name='Demo API Client', +description='An API client used for the authorization_code, refresh_token, and client_credentials flows', +access_token_validity_seconds=750, +refresh_token_validity_seconds=86400, +redirect_uris=[http://localhost:12345], +grant_types=[AUTHORIZATION_CODE, CLIENT_CREDENTIALS, REFRESH_TOKEN], +access_type='OFFLINE', +type='CONFIDENTIAL', +internal=False, +enabled=True, +strong_auth_supported=False, +claims_supported=False, +created='2017-07-11T18:45:37.098Z', +modified='2018-06-25T20:22:28.104Z', +secret='', +metadata='', +last_used='2017-07-11T18:45:37.098Z', +scope=[demo:api-client-scope:first, demo:api-client-scope:second] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/GetPersonalAccessTokenResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/GetPersonalAccessTokenResponse.md new file mode 100644 index 000000000..4d3f44c73 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/GetPersonalAccessTokenResponse.md @@ -0,0 +1,48 @@ +--- +id: v2024-get-personal-access-token-response +title: GetPersonalAccessTokenResponse +pagination_label: GetPersonalAccessTokenResponse +sidebar_label: GetPersonalAccessTokenResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'GetPersonalAccessTokenResponse', 'V2024GetPersonalAccessTokenResponse'] +slug: /tools/sdk/python/v2024/models/get-personal-access-token-response +tags: ['SDK', 'Software Development Kit', 'GetPersonalAccessTokenResponse', 'V2024GetPersonalAccessTokenResponse'] +--- + +# GetPersonalAccessTokenResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the personal access token (to be used as the username for Basic Auth). | [required] +**name** | **str** | The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. | [required] +**scope** | **[]str** | Scopes of the personal access token. | [required] +**owner** | [**PatOwner**](pat-owner) | | [required] +**created** | **datetime** | The date and time, down to the millisecond, when this personal access token was created. | [required] +**last_used** | **datetime** | The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed. | [optional] +**managed** | **bool** | If true, this token is managed by the SailPoint platform, and is not visible in the user interface. For example, Workflows will create managed personal access tokens for users who create workflows. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.get_personal_access_token_response import GetPersonalAccessTokenResponse + +get_personal_access_token_response = GetPersonalAccessTokenResponse( +id='86f1dc6fe8f54414950454cbb11278fa', +name='NodeJS Integration', +scope=[demo:personal-access-token-scope:first, demo:personal-access-token-scope:second], +owner=sailpoint.v2024.models.pat_owner.PatOwner( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', ), +created='2017-07-11T18:45:37.098Z', +last_used='2017-07-11T18:45:37.098Z', +managed=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/GetRoleAssignments200ResponseInner.md b/docs/tools/sdk/python/Reference/V2024/Models/GetRoleAssignments200ResponseInner.md new file mode 100644 index 000000000..bda4d435e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/GetRoleAssignments200ResponseInner.md @@ -0,0 +1,66 @@ +--- +id: v2024-get-role-assignments200-response-inner +title: GetRoleAssignments200ResponseInner +pagination_label: GetRoleAssignments200ResponseInner +sidebar_label: GetRoleAssignments200ResponseInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'GetRoleAssignments200ResponseInner', 'V2024GetRoleAssignments200ResponseInner'] +slug: /tools/sdk/python/v2024/models/get-role-assignments200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetRoleAssignments200ResponseInner', 'V2024GetRoleAssignments200ResponseInner'] +--- + +# GetRoleAssignments200ResponseInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Assignment Id | [optional] +**role** | [**BaseReferenceDto**](base-reference-dto) | | [optional] +**comments** | **str** | Comments added by the user when the assignment was made | [optional] +**assignment_source** | **str** | Source describing how this assignment was made | [optional] +**assigner** | [**RoleAssignmentDtoAssigner**](role-assignment-dto-assigner) | | [optional] +**assigned_dimensions** | [**[]BaseReferenceDto**](base-reference-dto) | Dimensions assigned related to this role | [optional] +**assignment_context** | [**RoleAssignmentDtoAssignmentContext**](role-assignment-dto-assignment-context) | | [optional] +**account_targets** | [**[]RoleTargetDto**](role-target-dto) | | [optional] +**remove_date** | **str** | Date that the assignment will be removed | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.get_role_assignments200_response_inner import GetRoleAssignments200ResponseInner + +get_role_assignments200_response_inner = GetRoleAssignments200ResponseInner( +id='1cbb0705b38c4226b1334eadd8874086', +role=sailpoint.v2024.models.base_reference_dto.BaseReferenceDto( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), +comments='I'm a new Engineer and need this role to do my work', +assignment_source='UI', +assigner=sailpoint.v2024.models.role_assignment_dto_assigner.RoleAssignmentDto_assigner( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), +assigned_dimensions=[{id=1acc8ffe5fcf457090de28bee2af36ee, type=DIMENSION, name=Northeast region}], +assignment_context={requested={contextAttributes=[{attribute=department, value=Engineering, derived=false}]}, matched=[{id=e7697a1e96d04db1ac7b0f4544915d2c, type=DIMENSION, name=Engineer}], computedDate=Wed Feb 14 10:58:42}, +account_targets=[ + sailpoint.v2024.models.role_target_dto.RoleTargetDto( + source = sailpoint.v2024.models.base_reference_dto.BaseReferenceDto( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), + account_info = sailpoint.v2024.models.account_info_dto.AccountInfoDto( + native_identity = 'CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com', + display_name = 'Abby.Smith', + uuid = '{ad9fc391-246d-40af-b248-b6556a2b7c01}', ), + role_name = 'Marketing', ) + ], +remove_date='Wed Feb 14 10:58:42' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/GetTenantContext200ResponseInner.md b/docs/tools/sdk/python/Reference/V2024/Models/GetTenantContext200ResponseInner.md new file mode 100644 index 000000000..5956efcee --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/GetTenantContext200ResponseInner.md @@ -0,0 +1,35 @@ +--- +id: v2024-get-tenant-context200-response-inner +title: GetTenantContext200ResponseInner +pagination_label: GetTenantContext200ResponseInner +sidebar_label: GetTenantContext200ResponseInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'GetTenantContext200ResponseInner', 'V2024GetTenantContext200ResponseInner'] +slug: /tools/sdk/python/v2024/models/get-tenant-context200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetTenantContext200ResponseInner', 'V2024GetTenantContext200ResponseInner'] +--- + +# GetTenantContext200ResponseInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | | [optional] +**value** | **str** | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.get_tenant_context200_response_inner import GetTenantContext200ResponseInner + +get_tenant_context200_response_inner = GetTenantContext200ResponseInner( +key='', +value='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/GrantType.md b/docs/tools/sdk/python/Reference/V2024/Models/GrantType.md new file mode 100644 index 000000000..e59ee71a9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/GrantType.md @@ -0,0 +1,25 @@ +--- +id: v2024-grant-type +title: GrantType +pagination_label: GrantType +sidebar_label: GrantType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'GrantType', 'V2024GrantType'] +slug: /tools/sdk/python/v2024/models/grant-type +tags: ['SDK', 'Software Development Kit', 'GrantType', 'V2024GrantType'] +--- + +# GrantType + +OAuth2 Grant Type + +## Enum + +* `CLIENT_CREDENTIALS` (value: `'CLIENT_CREDENTIALS'`) + +* `AUTHORIZATION_CODE` (value: `'AUTHORIZATION_CODE'`) + +* `REFRESH_TOKEN` (value: `'REFRESH_TOKEN'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/HttpAuthenticationType.md b/docs/tools/sdk/python/Reference/V2024/Models/HttpAuthenticationType.md new file mode 100644 index 000000000..97ec7ab18 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/HttpAuthenticationType.md @@ -0,0 +1,25 @@ +--- +id: v2024-http-authentication-type +title: HttpAuthenticationType +pagination_label: HttpAuthenticationType +sidebar_label: HttpAuthenticationType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'HttpAuthenticationType', 'V2024HttpAuthenticationType'] +slug: /tools/sdk/python/v2024/models/http-authentication-type +tags: ['SDK', 'Software Development Kit', 'HttpAuthenticationType', 'V2024HttpAuthenticationType'] +--- + +# HttpAuthenticationType + +Defines the HTTP Authentication type. Additional values may be added in the future. If *NO_AUTH* is selected, no extra information will be in HttpConfig. If *BASIC_AUTH* is selected, HttpConfig will include BasicAuthConfig with Username and Password as strings. If *BEARER_TOKEN* is selected, HttpConfig will include BearerTokenAuthConfig with Token as string. + +## Enum + +* `NO_AUTH` (value: `'NO_AUTH'`) + +* `BASIC_AUTH` (value: `'BASIC_AUTH'`) + +* `BEARER_TOKEN` (value: `'BEARER_TOKEN'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/HttpConfig.md b/docs/tools/sdk/python/Reference/V2024/Models/HttpConfig.md new file mode 100644 index 000000000..6868f5b9c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/HttpConfig.md @@ -0,0 +1,44 @@ +--- +id: v2024-http-config +title: HttpConfig +pagination_label: HttpConfig +sidebar_label: HttpConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'HttpConfig', 'V2024HttpConfig'] +slug: /tools/sdk/python/v2024/models/http-config +tags: ['SDK', 'Software Development Kit', 'HttpConfig', 'V2024HttpConfig'] +--- + +# HttpConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**url** | **str** | URL of the external/custom integration. | [required] +**http_dispatch_mode** | [**HttpDispatchMode**](http-dispatch-mode) | | [required] +**http_authentication_type** | [**HttpAuthenticationType**](http-authentication-type) | | [optional] [default to HttpAuthenticationType.NO_AUTH] +**basic_auth_config** | [**BasicAuthConfig**](basic-auth-config) | | [optional] +**bearer_token_auth_config** | [**BearerTokenAuthConfig**](bearer-token-auth-config) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.http_config import HttpConfig + +http_config = HttpConfig( +url='https://www.example.com', +http_dispatch_mode='SYNC', +http_authentication_type='NO_AUTH', +basic_auth_config=sailpoint.v2024.models.basic_auth_config.BasicAuthConfig( + user_name = 'user@example.com', + password = '', ), +bearer_token_auth_config=sailpoint.v2024.models.bearer_token_auth_config.BearerTokenAuthConfig( + bearer_token = '', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/HttpDispatchMode.md b/docs/tools/sdk/python/Reference/V2024/Models/HttpDispatchMode.md new file mode 100644 index 000000000..fec22d876 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/HttpDispatchMode.md @@ -0,0 +1,25 @@ +--- +id: v2024-http-dispatch-mode +title: HttpDispatchMode +pagination_label: HttpDispatchMode +sidebar_label: HttpDispatchMode +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'HttpDispatchMode', 'V2024HttpDispatchMode'] +slug: /tools/sdk/python/v2024/models/http-dispatch-mode +tags: ['SDK', 'Software Development Kit', 'HttpDispatchMode', 'V2024HttpDispatchMode'] +--- + +# HttpDispatchMode + +HTTP response modes, i.e. SYNC, ASYNC, or DYNAMIC. + +## Enum + +* `SYNC` (value: `'SYNC'`) + +* `ASYNC` (value: `'ASYNC'`) + +* `DYNAMIC` (value: `'DYNAMIC'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentitiesAccountsBulkRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentitiesAccountsBulkRequest.md new file mode 100644 index 000000000..fd3af6fba --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentitiesAccountsBulkRequest.md @@ -0,0 +1,33 @@ +--- +id: v2024-identities-accounts-bulk-request +title: IdentitiesAccountsBulkRequest +pagination_label: IdentitiesAccountsBulkRequest +sidebar_label: IdentitiesAccountsBulkRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentitiesAccountsBulkRequest', 'V2024IdentitiesAccountsBulkRequest'] +slug: /tools/sdk/python/v2024/models/identities-accounts-bulk-request +tags: ['SDK', 'Software Development Kit', 'IdentitiesAccountsBulkRequest', 'V2024IdentitiesAccountsBulkRequest'] +--- + +# IdentitiesAccountsBulkRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_ids** | **[]str** | The ids of the identities for which enable/disable accounts. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identities_accounts_bulk_request import IdentitiesAccountsBulkRequest + +identities_accounts_bulk_request = IdentitiesAccountsBulkRequest( +identity_ids=[2c91808384203c2d018437e631158308, 2c9180858082150f0180893dbaf553fe] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentitiesDetailsReportArguments.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentitiesDetailsReportArguments.md new file mode 100644 index 000000000..629c0d27d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentitiesDetailsReportArguments.md @@ -0,0 +1,34 @@ +--- +id: v2024-identities-details-report-arguments +title: IdentitiesDetailsReportArguments +pagination_label: IdentitiesDetailsReportArguments +sidebar_label: IdentitiesDetailsReportArguments +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentitiesDetailsReportArguments', 'V2024IdentitiesDetailsReportArguments'] +slug: /tools/sdk/python/v2024/models/identities-details-report-arguments +tags: ['SDK', 'Software Development Kit', 'IdentitiesDetailsReportArguments', 'V2024IdentitiesDetailsReportArguments'] +--- + +# IdentitiesDetailsReportArguments + +Arguments for Identities Details report (IDENTITIES_DETAILS) + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**correlated_only** | **bool** | Flag to specify if only correlated identities are included in report. | [required][default to False] +} + +## Example + +```python +from sailpoint.v2024.models.identities_details_report_arguments import IdentitiesDetailsReportArguments + +identities_details_report_arguments = IdentitiesDetailsReportArguments( +correlated_only=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentitiesReportArguments.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentitiesReportArguments.md new file mode 100644 index 000000000..b9980584d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentitiesReportArguments.md @@ -0,0 +1,34 @@ +--- +id: v2024-identities-report-arguments +title: IdentitiesReportArguments +pagination_label: IdentitiesReportArguments +sidebar_label: IdentitiesReportArguments +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentitiesReportArguments', 'V2024IdentitiesReportArguments'] +slug: /tools/sdk/python/v2024/models/identities-report-arguments +tags: ['SDK', 'Software Development Kit', 'IdentitiesReportArguments', 'V2024IdentitiesReportArguments'] +--- + +# IdentitiesReportArguments + +Arguments for Identities report (IDENTITIES) + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**correlated_only** | **bool** | Flag to specify if only correlated identities are included in report. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2024.models.identities_report_arguments import IdentitiesReportArguments + +identities_report_arguments = IdentitiesReportArguments( +correlated_only=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Identity.md b/docs/tools/sdk/python/Reference/V2024/Models/Identity.md new file mode 100644 index 000000000..511c16498 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Identity.md @@ -0,0 +1,60 @@ +--- +id: v2024-identity +title: Identity +pagination_label: Identity +sidebar_label: Identity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Identity', 'V2024Identity'] +slug: /tools/sdk/python/v2024/models/identity +tags: ['SDK', 'Software Development Kit', 'Identity', 'V2024Identity'] +--- + +# Identity + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | System-generated unique ID of the identity | [optional] [readonly] +**name** | **str** | The identity's name is equivalent to its Display Name attribute. | [required] +**created** | **datetime** | Creation date of the identity | [optional] [readonly] +**modified** | **datetime** | Last modification date of the identity | [optional] [readonly] +**alias** | **str** | The identity's alternate unique identifier is equivalent to its Account Name on the authoritative source account schema. | [optional] +**email_address** | **str** | The email address of the identity | [optional] +**processing_state** | **Enum** [ 'ERROR', 'OK' ] | The processing state of the identity | [optional] +**identity_status** | **Enum** [ 'UNREGISTERED', 'REGISTERED', 'PENDING', 'WARNING', 'DISABLED', 'ACTIVE', 'DEACTIVATED', 'TERMINATED', 'ERROR', 'LOCKED' ] | The identity's status in the system | [optional] +**manager_ref** | [**IdentityManagerRef**](identity-manager-ref) | | [optional] +**is_manager** | **bool** | Whether this identity is a manager of another identity | [optional] [default to False] +**last_refresh** | **datetime** | The last time the identity was refreshed by the system | [optional] +**attributes** | **object** | A map with the identity attributes for the identity | [optional] +**lifecycle_state** | [**IdentityLifecycleState**](identity-lifecycle-state) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity import Identity + +identity = Identity( +id='01f04e428c484542a241dc89c303b178', +name='Walter White', +created='2023-01-03T21:16:22.432Z', +modified='2023-01-03T21:16:22.432Z', +alias='walter.white', +email_address='walter.white@example.com', +processing_state='ERROR', +identity_status='LOCKED', +manager_ref=sailpoint.v2024.models.identity_manager_ref.Identity_managerRef( + type = 'IDENTITY', + id = '2c4180a46faadee4016fb4e018c20626', + name = 'Robert Robinson', ), +is_manager=True, +last_refresh='2020-11-22T15:42:31.123Z', +attributes={uid=86754, firstname=Walter, cloudStatus=UNREGISTERED, displayName=Walter White, identificationNumber=86754, lastSyncDate=1470348809380, email=walter.white@example.com, lastname=White}, +lifecycle_state= +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Identity1.md b/docs/tools/sdk/python/Reference/V2024/Models/Identity1.md new file mode 100644 index 000000000..04ad70398 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/Identity1.md @@ -0,0 +1,36 @@ +--- +id: v2024-identity1 +title: Identity1 +pagination_label: Identity1 +sidebar_label: Identity1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Identity1', 'V2024Identity1'] +slug: /tools/sdk/python/v2024/models/identity1 +tags: ['SDK', 'Software Development Kit', 'Identity1', 'V2024Identity1'] +--- + +# Identity1 + +The definition of an Identity according to the Reassignment Configuration service + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the object | [optional] +**name** | **str** | Human-readable display name of the object | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity1 import Identity1 + +identity1 = Identity1( +id='2c91808380aa05580180aaaaf1940410', +name='William Wilson' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityAccess.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityAccess.md new file mode 100644 index 000000000..999a7358a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityAccess.md @@ -0,0 +1,59 @@ +--- +id: v2024-identity-access +title: IdentityAccess +pagination_label: IdentityAccess +sidebar_label: IdentityAccess +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityAccess', 'V2024IdentityAccess'] +slug: /tools/sdk/python/v2024/models/identity-access +tags: ['SDK', 'Software Development Kit', 'IdentityAccess', 'V2024IdentityAccess'] +--- + +# IdentityAccess + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the referenced object. | [optional] +**name** | **str** | The human readable name of the referenced object. | [optional] +**display_name** | **str** | | [optional] +**description** | **str** | Description of access item. | [optional] +**type** | **str** | Type of the access item. | [optional] +**source** | [**Reference**](reference) | | [optional] +**owner** | [**DisplayReference**](display-reference) | | [optional] +**revocable** | **bool** | | [optional] +**privileged** | **bool** | | [optional] +**attribute** | **str** | | [optional] +**value** | **str** | | [optional] +**standalone** | **bool** | | [optional] +**disabled** | **bool** | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity_access import IdentityAccess + +identity_access = IdentityAccess( +id='2c91808568c529c60168cca6f90c1313', +name='John Doe', +display_name='John Q. Doe', +description='', +type='ROLE', +source=sailpoint.v2024.models.reference.Reference( + id = '2c91808568c529c60168cca6f90c1313', + name = 'John Doe', ), +owner=, +revocable=True, +privileged=False, +attribute='memberOf', +value='CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com', +standalone=False, +disabled=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityAssociationDetails.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityAssociationDetails.md new file mode 100644 index 000000000..566e1a611 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityAssociationDetails.md @@ -0,0 +1,39 @@ +--- +id: v2024-identity-association-details +title: IdentityAssociationDetails +pagination_label: IdentityAssociationDetails +sidebar_label: IdentityAssociationDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityAssociationDetails', 'V2024IdentityAssociationDetails'] +slug: /tools/sdk/python/v2024/models/identity-association-details +tags: ['SDK', 'Software Development Kit', 'IdentityAssociationDetails', 'V2024IdentityAssociationDetails'] +--- + +# IdentityAssociationDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **str** | any additional context information of the http call result | [optional] +**association_details** | [**[]IdentityAssociationDetailsAssociationDetailsInner**](identity-association-details-association-details-inner) | list of all the resource associations for the identity | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity_association_details import IdentityAssociationDetails + +identity_association_details = IdentityAssociationDetails( +message='Identity cannot be deleted as it is owner of following resources', +association_details=[ + sailpoint.v2024.models.identity_association_details_association_details_inner.IdentityAssociationDetails_associationDetails_inner( + association_type = 'CAMPAIGN_OWNER', + entities = {id=b660a232f05b4e04812ca974b3011e0f, name=Gaston.800ddf9640a, type=CAMPAIGN_CAMPAIGNER}, ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityAssociationDetailsAssociationDetailsInner.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityAssociationDetailsAssociationDetailsInner.md new file mode 100644 index 000000000..411fe7015 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityAssociationDetailsAssociationDetailsInner.md @@ -0,0 +1,35 @@ +--- +id: v2024-identity-association-details-association-details-inner +title: IdentityAssociationDetailsAssociationDetailsInner +pagination_label: IdentityAssociationDetailsAssociationDetailsInner +sidebar_label: IdentityAssociationDetailsAssociationDetailsInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityAssociationDetailsAssociationDetailsInner', 'V2024IdentityAssociationDetailsAssociationDetailsInner'] +slug: /tools/sdk/python/v2024/models/identity-association-details-association-details-inner +tags: ['SDK', 'Software Development Kit', 'IdentityAssociationDetailsAssociationDetailsInner', 'V2024IdentityAssociationDetailsAssociationDetailsInner'] +--- + +# IdentityAssociationDetailsAssociationDetailsInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**association_type** | **str** | association type with the identity | [optional] +**entities** | [**[]IdentityEntities**](identity-entities) | the specific resource this identity has ownership on | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity_association_details_association_details_inner import IdentityAssociationDetailsAssociationDetailsInner + +identity_association_details_association_details_inner = IdentityAssociationDetailsAssociationDetailsInner( +association_type='CAMPAIGN_OWNER', +entities={id=b660a232f05b4e04812ca974b3011e0f, name=Gaston.800ddf9640a, type=CAMPAIGN_CAMPAIGNER} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityAttribute.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityAttribute.md new file mode 100644 index 000000000..666c9c6a3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityAttribute.md @@ -0,0 +1,51 @@ +--- +id: v2024-identity-attribute +title: IdentityAttribute +pagination_label: IdentityAttribute +sidebar_label: IdentityAttribute +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityAttribute', 'V2024IdentityAttribute'] +slug: /tools/sdk/python/v2024/models/identity-attribute +tags: ['SDK', 'Software Development Kit', 'IdentityAttribute', 'V2024IdentityAttribute'] +--- + +# IdentityAttribute + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Identity attribute's technical name. | [required] +**display_name** | **str** | Identity attribute's business-friendly name. | [optional] +**standard** | **bool** | Indicates whether the attribute is 'standard' or 'default'. | [optional] [default to False] +**type** | **str** | Identity attribute's type. | [optional] +**multi** | **bool** | Indicates whether the identity attribute is multi-valued. | [optional] [default to False] +**searchable** | **bool** | Indicates whether the identity attribute is searchable. | [optional] [default to False] +**system** | **bool** | Indicates whether the identity attribute is 'system', meaning that it doesn't have a source and isn't configurable. | [optional] [default to False] +**sources** | [**[]Source1**](source1) | Identity attribute's list of sources - this specifies how the rule's value is derived. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity_attribute import IdentityAttribute + +identity_attribute = IdentityAttribute( +name='costCenter', +display_name='Cost Center', +standard=False, +type='string', +multi=False, +searchable=False, +system=False, +sources=[ + sailpoint.v2024.models.source_1.Source_1( + type = 'rule', + properties = {ruleType=IdentityAttribute, ruleName=Cloud Promote Identity Attribute}, ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityAttributeConfig.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityAttributeConfig.md new file mode 100644 index 000000000..5c8d58f40 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityAttributeConfig.md @@ -0,0 +1,42 @@ +--- +id: v2024-identity-attribute-config +title: IdentityAttributeConfig +pagination_label: IdentityAttributeConfig +sidebar_label: IdentityAttributeConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityAttributeConfig', 'V2024IdentityAttributeConfig'] +slug: /tools/sdk/python/v2024/models/identity-attribute-config +tags: ['SDK', 'Software Development Kit', 'IdentityAttributeConfig', 'V2024IdentityAttributeConfig'] +--- + +# IdentityAttributeConfig + +Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | Backend will only promote values if the profile/mapping is enabled. | [optional] [default to False] +**attribute_transforms** | [**[]IdentityAttributeTransform**](identity-attribute-transform) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity_attribute_config import IdentityAttributeConfig + +identity_attribute_config = IdentityAttributeConfig( +enabled=True, +attribute_transforms=[ + sailpoint.v2024.models.identity_attribute_transform.IdentityAttributeTransform( + identity_attribute_name = 'email', + transform_definition = sailpoint.v2024.models.transform_definition.TransformDefinition( + type = 'accountAttribute', + attributes = {attributeName=e-mail, sourceName=MySource, sourceId=2c9180877a826e68017a8c0b03da1a53}, ), ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityAttributeNames.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityAttributeNames.md new file mode 100644 index 000000000..aaa035e09 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityAttributeNames.md @@ -0,0 +1,34 @@ +--- +id: v2024-identity-attribute-names +title: IdentityAttributeNames +pagination_label: IdentityAttributeNames +sidebar_label: IdentityAttributeNames +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityAttributeNames', 'V2024IdentityAttributeNames'] +slug: /tools/sdk/python/v2024/models/identity-attribute-names +tags: ['SDK', 'Software Development Kit', 'IdentityAttributeNames', 'V2024IdentityAttributeNames'] +--- + +# IdentityAttributeNames + +Identity attribute IDs. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ids** | **[]str** | List of identity attributes' technical names. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity_attribute_names import IdentityAttributeNames + +identity_attribute_names = IdentityAttributeNames( +ids=[name, displayName] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityAttributePreview.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityAttributePreview.md new file mode 100644 index 000000000..ede1aef7c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityAttributePreview.md @@ -0,0 +1,39 @@ +--- +id: v2024-identity-attribute-preview +title: IdentityAttributePreview +pagination_label: IdentityAttributePreview +sidebar_label: IdentityAttributePreview +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityAttributePreview', 'V2024IdentityAttributePreview'] +slug: /tools/sdk/python/v2024/models/identity-attribute-preview +tags: ['SDK', 'Software Development Kit', 'IdentityAttributePreview', 'V2024IdentityAttributePreview'] +--- + +# IdentityAttributePreview + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the attribute that is being previewed. | [optional] +**value** | **str** | Value that was derived during the preview. | [optional] +**previous_value** | **str** | The value of the attribute before the preview. | [optional] +**error_messages** | [**[]ErrorMessageDto**](error-message-dto) | List of error messages | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity_attribute_preview import IdentityAttributePreview + +identity_attribute_preview = IdentityAttributePreview( +name='email', +value='email@mail.com', +previous_value='oldEmail@mail.com', +error_messages={locale=en-US, localeOrigin=DEFAULT, text=Error Message} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityAttributeTransform.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityAttributeTransform.md new file mode 100644 index 000000000..464113f0f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityAttributeTransform.md @@ -0,0 +1,38 @@ +--- +id: v2024-identity-attribute-transform +title: IdentityAttributeTransform +pagination_label: IdentityAttributeTransform +sidebar_label: IdentityAttributeTransform +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityAttributeTransform', 'V2024IdentityAttributeTransform'] +slug: /tools/sdk/python/v2024/models/identity-attribute-transform +tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform', 'V2024IdentityAttributeTransform'] +--- + +# IdentityAttributeTransform + +Transform definition for an identity attribute. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_attribute_name** | **str** | Identity attribute's name. | [optional] +**transform_definition** | [**TransformDefinition**](transform-definition) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity_attribute_transform import IdentityAttributeTransform + +identity_attribute_transform = IdentityAttributeTransform( +identity_attribute_name='email', +transform_definition=sailpoint.v2024.models.transform_definition.TransformDefinition( + type = 'accountAttribute', + attributes = {attributeName=e-mail, sourceName=MySource, sourceId=2c9180877a826e68017a8c0b03da1a53}, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityAttributesChanged.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityAttributesChanged.md new file mode 100644 index 000000000..9fafe2d54 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityAttributesChanged.md @@ -0,0 +1,43 @@ +--- +id: v2024-identity-attributes-changed +title: IdentityAttributesChanged +pagination_label: IdentityAttributesChanged +sidebar_label: IdentityAttributesChanged +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityAttributesChanged', 'V2024IdentityAttributesChanged'] +slug: /tools/sdk/python/v2024/models/identity-attributes-changed +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChanged', 'V2024IdentityAttributesChanged'] +--- + +# IdentityAttributesChanged + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity** | [**IdentityAttributesChangedIdentity**](identity-attributes-changed-identity) | | [required] +**changes** | [**[]IdentityAttributesChangedChangesInner**](identity-attributes-changed-changes-inner) | A list of one or more identity attributes that changed on the identity. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.identity_attributes_changed import IdentityAttributesChanged + +identity_attributes_changed = IdentityAttributesChanged( +identity=sailpoint.v2024.models.identity_attributes_changed_identity.IdentityAttributesChanged_identity( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', ), +changes=[ + sailpoint.v2024.models.identity_attributes_changed_changes_inner.IdentityAttributesChanged_changes_inner( + attribute = 'department', + old_value = sales, + new_value = marketing, ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityAttributesChangedChangesInner.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityAttributesChangedChangesInner.md new file mode 100644 index 000000000..4c3e30d57 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityAttributesChangedChangesInner.md @@ -0,0 +1,37 @@ +--- +id: v2024-identity-attributes-changed-changes-inner +title: IdentityAttributesChangedChangesInner +pagination_label: IdentityAttributesChangedChangesInner +sidebar_label: IdentityAttributesChangedChangesInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityAttributesChangedChangesInner', 'V2024IdentityAttributesChangedChangesInner'] +slug: /tools/sdk/python/v2024/models/identity-attributes-changed-changes-inner +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedChangesInner', 'V2024IdentityAttributesChangedChangesInner'] +--- + +# IdentityAttributesChangedChangesInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attribute** | **str** | The name of the identity attribute that changed. | [required] +**old_value** | [**IdentityAttributesChangedChangesInnerOldValue**](identity-attributes-changed-changes-inner-old-value) | | [optional] +**new_value** | [**IdentityAttributesChangedChangesInnerNewValue**](identity-attributes-changed-changes-inner-new-value) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity_attributes_changed_changes_inner import IdentityAttributesChangedChangesInner + +identity_attributes_changed_changes_inner = IdentityAttributesChangedChangesInner( +attribute='department', +old_value=sales, +new_value=marketing +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityAttributesChangedChangesInnerNewValue.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityAttributesChangedChangesInnerNewValue.md new file mode 100644 index 000000000..bc232413f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityAttributesChangedChangesInnerNewValue.md @@ -0,0 +1,32 @@ +--- +id: v2024-identity-attributes-changed-changes-inner-new-value +title: IdentityAttributesChangedChangesInnerNewValue +pagination_label: IdentityAttributesChangedChangesInnerNewValue +sidebar_label: IdentityAttributesChangedChangesInnerNewValue +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityAttributesChangedChangesInnerNewValue', 'V2024IdentityAttributesChangedChangesInnerNewValue'] +slug: /tools/sdk/python/v2024/models/identity-attributes-changed-changes-inner-new-value +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedChangesInnerNewValue', 'V2024IdentityAttributesChangedChangesInnerNewValue'] +--- + +# IdentityAttributesChangedChangesInnerNewValue + +The value of the identity attribute after it changed. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +} + +## Example + +```python +from sailpoint.v2024.models.identity_attributes_changed_changes_inner_new_value import IdentityAttributesChangedChangesInnerNewValue + +identity_attributes_changed_changes_inner_new_value = IdentityAttributesChangedChangesInnerNewValue( +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityAttributesChangedChangesInnerOldValue.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityAttributesChangedChangesInnerOldValue.md new file mode 100644 index 000000000..b625fa692 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityAttributesChangedChangesInnerOldValue.md @@ -0,0 +1,32 @@ +--- +id: v2024-identity-attributes-changed-changes-inner-old-value +title: IdentityAttributesChangedChangesInnerOldValue +pagination_label: IdentityAttributesChangedChangesInnerOldValue +sidebar_label: IdentityAttributesChangedChangesInnerOldValue +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityAttributesChangedChangesInnerOldValue', 'V2024IdentityAttributesChangedChangesInnerOldValue'] +slug: /tools/sdk/python/v2024/models/identity-attributes-changed-changes-inner-old-value +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedChangesInnerOldValue', 'V2024IdentityAttributesChangedChangesInnerOldValue'] +--- + +# IdentityAttributesChangedChangesInnerOldValue + +The value of the identity attribute before it changed. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +} + +## Example + +```python +from sailpoint.v2024.models.identity_attributes_changed_changes_inner_old_value import IdentityAttributesChangedChangesInnerOldValue + +identity_attributes_changed_changes_inner_old_value = IdentityAttributesChangedChangesInnerOldValue( +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityAttributesChangedChangesInnerOldValueOneOfValue.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityAttributesChangedChangesInnerOldValueOneOfValue.md new file mode 100644 index 000000000..9650139c6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityAttributesChangedChangesInnerOldValueOneOfValue.md @@ -0,0 +1,31 @@ +--- +id: v2024-identity-attributes-changed-changes-inner-old-value-one-of-value +title: IdentityAttributesChangedChangesInnerOldValueOneOfValue +pagination_label: IdentityAttributesChangedChangesInnerOldValueOneOfValue +sidebar_label: IdentityAttributesChangedChangesInnerOldValueOneOfValue +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityAttributesChangedChangesInnerOldValueOneOfValue', 'V2024IdentityAttributesChangedChangesInnerOldValueOneOfValue'] +slug: /tools/sdk/python/v2024/models/identity-attributes-changed-changes-inner-old-value-one-of-value +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedChangesInnerOldValueOneOfValue', 'V2024IdentityAttributesChangedChangesInnerOldValueOneOfValue'] +--- + +# IdentityAttributesChangedChangesInnerOldValueOneOfValue + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +} + +## Example + +```python +from sailpoint.v2024.models.identity_attributes_changed_changes_inner_old_value_one_of_value import IdentityAttributesChangedChangesInnerOldValueOneOfValue + +identity_attributes_changed_changes_inner_old_value_one_of_value = IdentityAttributesChangedChangesInnerOldValueOneOfValue( +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityAttributesChangedIdentity.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityAttributesChangedIdentity.md new file mode 100644 index 000000000..233388422 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityAttributesChangedIdentity.md @@ -0,0 +1,38 @@ +--- +id: v2024-identity-attributes-changed-identity +title: IdentityAttributesChangedIdentity +pagination_label: IdentityAttributesChangedIdentity +sidebar_label: IdentityAttributesChangedIdentity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityAttributesChangedIdentity', 'V2024IdentityAttributesChangedIdentity'] +slug: /tools/sdk/python/v2024/models/identity-attributes-changed-identity +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedIdentity', 'V2024IdentityAttributesChangedIdentity'] +--- + +# IdentityAttributesChangedIdentity + +Identity whose attributes changed. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | DTO type of identity whose attributes changed. | [required] +**id** | **str** | ID of identity whose attributes changed. | [required] +**name** | **str** | Display name of identity whose attributes changed. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.identity_attributes_changed_identity import IdentityAttributesChangedIdentity + +identity_attributes_changed_identity = IdentityAttributesChangedIdentity( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20642', +name='Michael Michaels' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityCertDecisionSummary.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityCertDecisionSummary.md new file mode 100644 index 000000000..f83c844e8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityCertDecisionSummary.md @@ -0,0 +1,63 @@ +--- +id: v2024-identity-cert-decision-summary +title: IdentityCertDecisionSummary +pagination_label: IdentityCertDecisionSummary +sidebar_label: IdentityCertDecisionSummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityCertDecisionSummary', 'V2024IdentityCertDecisionSummary'] +slug: /tools/sdk/python/v2024/models/identity-cert-decision-summary +tags: ['SDK', 'Software Development Kit', 'IdentityCertDecisionSummary', 'V2024IdentityCertDecisionSummary'] +--- + +# IdentityCertDecisionSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entitlement_decisions_made** | **int** | Number of entitlement decisions that have been made | [optional] +**access_profile_decisions_made** | **int** | Number of access profile decisions that have been made | [optional] +**role_decisions_made** | **int** | Number of role decisions that have been made | [optional] +**account_decisions_made** | **int** | Number of account decisions that have been made | [optional] +**entitlement_decisions_total** | **int** | The total number of entitlement decisions on the certification, both complete and incomplete | [optional] +**access_profile_decisions_total** | **int** | The total number of access profile decisions on the certification, both complete and incomplete | [optional] +**role_decisions_total** | **int** | The total number of role decisions on the certification, both complete and incomplete | [optional] +**account_decisions_total** | **int** | The total number of account decisions on the certification, both complete and incomplete | [optional] +**entitlements_approved** | **int** | The number of entitlement decisions that have been made which were approved | [optional] +**entitlements_revoked** | **int** | The number of entitlement decisions that have been made which were revoked | [optional] +**access_profiles_approved** | **int** | The number of access profile decisions that have been made which were approved | [optional] +**access_profiles_revoked** | **int** | The number of access profile decisions that have been made which were revoked | [optional] +**roles_approved** | **int** | The number of role decisions that have been made which were approved | [optional] +**roles_revoked** | **int** | The number of role decisions that have been made which were revoked | [optional] +**accounts_approved** | **int** | The number of account decisions that have been made which were approved | [optional] +**accounts_revoked** | **int** | The number of account decisions that have been made which were revoked | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity_cert_decision_summary import IdentityCertDecisionSummary + +identity_cert_decision_summary = IdentityCertDecisionSummary( +entitlement_decisions_made=3, +access_profile_decisions_made=5, +role_decisions_made=2, +account_decisions_made=4, +entitlement_decisions_total=6, +access_profile_decisions_total=10, +role_decisions_total=4, +account_decisions_total=8, +entitlements_approved=2, +entitlements_revoked=1, +access_profiles_approved=3, +access_profiles_revoked=2, +roles_approved=2, +roles_revoked=0, +accounts_approved=1, +accounts_revoked=3 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityCertificationDto.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityCertificationDto.md new file mode 100644 index 000000000..e635af105 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityCertificationDto.md @@ -0,0 +1,90 @@ +--- +id: v2024-identity-certification-dto +title: IdentityCertificationDto +pagination_label: IdentityCertificationDto +sidebar_label: IdentityCertificationDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityCertificationDto', 'V2024IdentityCertificationDto'] +slug: /tools/sdk/python/v2024/models/identity-certification-dto +tags: ['SDK', 'Software Development Kit', 'IdentityCertificationDto', 'V2024IdentityCertificationDto'] +--- + +# IdentityCertificationDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | id of the certification | [optional] +**name** | **str** | name of the certification | [optional] +**campaign** | [**CampaignReference**](campaign-reference) | | [optional] +**completed** | **bool** | Have all decisions been made? | [optional] +**identities_completed** | **int** | The number of identities for whom all decisions have been made and are complete. | [optional] +**identities_total** | **int** | The total number of identities in the Certification, both complete and incomplete. | [optional] +**created** | **datetime** | created date | [optional] +**modified** | **datetime** | modified date | [optional] +**decisions_made** | **int** | The number of approve/revoke/acknowledge decisions that have been made. | [optional] +**decisions_total** | **int** | The total number of approve/revoke/acknowledge decisions. | [optional] +**due** | **datetime** | The due date of the certification. | [optional] +**signed** | **datetime** | The date the reviewer signed off on the Certification. | [optional] +**reviewer** | [**Reviewer**](reviewer) | | [optional] +**reassignment** | [**Reassignment**](reassignment) | | [optional] +**has_errors** | **bool** | Identifies if the certification has an error | [optional] +**error_message** | **str** | Description of the certification error | [optional] +**phase** | [**CertificationPhase**](certification-phase) | | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity_certification_dto import IdentityCertificationDto + +identity_certification_dto = IdentityCertificationDto( +id='2c9180835d2e5168015d32f890ca1581', +name='Source Owner Access Review for Employees [source]', +campaign=sailpoint.v2024.models.campaign_reference.CampaignReference( + id = 'ef38f94347e94562b5bb8424a56397d8', + name = 'Campaign Name', + type = 'CAMPAIGN', + campaign_type = 'MANAGER', + description = 'A description of the campaign', + correlated_status = 'CORRELATED', + mandatory_comment_requirement = 'NO_DECISIONS', ), +completed=True, +identities_completed=5, +identities_total=10, +created='2018-06-25T20:22:28.104Z', +modified='2018-06-25T20:22:28.104Z', +decisions_made=20, +decisions_total=40, +due='2018-10-19T13:49:37.385Z', +signed='2018-10-19T13:49:37.385Z', +reviewer=sailpoint.v2024.models.reviewer.Reviewer( + id = 'ef38f94347e94562b5bb8424a56397d8', + name = 'Reviewer Name', + email = 'reviewer@test.com', + type = 'IDENTITY', + created = '2018-06-25T20:22:28.104Z', + modified = '2018-06-25T20:22:28.104Z', ), +reassignment=sailpoint.v2024.models.reassignment.Reassignment( + from = sailpoint.v2024.models.certification_reference.CertificationReference( + id = 'ef38f94347e94562b5bb8424a56397d8', + name = 'Certification Name', + type = 'CERTIFICATION', + reviewer = sailpoint.v2024.models.reviewer.Reviewer( + id = 'ef38f94347e94562b5bb8424a56397d8', + name = 'Reviewer Name', + email = 'reviewer@test.com', + type = 'IDENTITY', + created = '2018-06-25T20:22:28.104Z', + modified = '2018-06-25T20:22:28.104Z', ), ), + comment = 'Reassigned for a reason', ), +has_errors=False, +error_message='The certification has an error', +phase='ACTIVE' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityCertified.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityCertified.md new file mode 100644 index 000000000..944cfc69d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityCertified.md @@ -0,0 +1,49 @@ +--- +id: v2024-identity-certified +title: IdentityCertified +pagination_label: IdentityCertified +sidebar_label: IdentityCertified +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityCertified', 'V2024IdentityCertified'] +slug: /tools/sdk/python/v2024/models/identity-certified +tags: ['SDK', 'Software Development Kit', 'IdentityCertified', 'V2024IdentityCertified'] +--- + +# IdentityCertified + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**certification_id** | **str** | the id of the certification item | [optional] +**certification_name** | **str** | the certification item name | [optional] +**signed_date** | **str** | the date ceritification was signed | [optional] +**certifiers** | [**[]CertifierResponse**](certifier-response) | this field is deprecated and may go away | [optional] +**reviewers** | [**[]CertifierResponse**](certifier-response) | The list of identities who review this certification | [optional] +**signer** | [**CertifierResponse**](certifier-response) | | [optional] +**event_type** | **str** | the event type | [optional] +**dt** | **str** | the date of event | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity_certified import IdentityCertified + +identity_certified = IdentityCertified( +certification_id='2c91808a77ff216301782327a50f09bf', +certification_name='Cert name', +signed_date='2019-03-08T22:37:33.901Z', +certifiers=[{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}], +reviewers=[{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}], +signer=sailpoint.v2024.models.certifier_response.CertifierResponse( + id = '8a80828f643d484f01643e14202e206f', + display_name = 'John Snow', ), +event_type='IdentityCertified', +dt='2019-03-08T22:37:33.901Z' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityCompareResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityCompareResponse.md new file mode 100644 index 000000000..9d29a2584 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityCompareResponse.md @@ -0,0 +1,35 @@ +--- +id: v2024-identity-compare-response +title: IdentityCompareResponse +pagination_label: IdentityCompareResponse +sidebar_label: IdentityCompareResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityCompareResponse', 'V2024IdentityCompareResponse'] +slug: /tools/sdk/python/v2024/models/identity-compare-response +tags: ['SDK', 'Software Development Kit', 'IdentityCompareResponse', 'V2024IdentityCompareResponse'] +--- + +# IdentityCompareResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_item_diff** | **map[string]object** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity_compare_response import IdentityCompareResponse + +identity_compare_response = IdentityCompareResponse( +access_item_diff={ + 'key' : None + } +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityCreated.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityCreated.md new file mode 100644 index 000000000..00d47c3d5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityCreated.md @@ -0,0 +1,38 @@ +--- +id: v2024-identity-created +title: IdentityCreated +pagination_label: IdentityCreated +sidebar_label: IdentityCreated +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityCreated', 'V2024IdentityCreated'] +slug: /tools/sdk/python/v2024/models/identity-created +tags: ['SDK', 'Software Development Kit', 'IdentityCreated', 'V2024IdentityCreated'] +--- + +# IdentityCreated + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity** | [**IdentityCreatedIdentity**](identity-created-identity) | | [required] +**attributes** | **map[string]object** | The attributes assigned to the identity. Attributes are determined by the identity profile. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.identity_created import IdentityCreated + +identity_created = IdentityCreated( +identity=sailpoint.v2024.models.identity_created_identity.IdentityCreated_identity( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', ), +attributes={firstname=John} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityCreatedIdentity.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityCreatedIdentity.md new file mode 100644 index 000000000..75a0637e4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityCreatedIdentity.md @@ -0,0 +1,38 @@ +--- +id: v2024-identity-created-identity +title: IdentityCreatedIdentity +pagination_label: IdentityCreatedIdentity +sidebar_label: IdentityCreatedIdentity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityCreatedIdentity', 'V2024IdentityCreatedIdentity'] +slug: /tools/sdk/python/v2024/models/identity-created-identity +tags: ['SDK', 'Software Development Kit', 'IdentityCreatedIdentity', 'V2024IdentityCreatedIdentity'] +--- + +# IdentityCreatedIdentity + +Created identity. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Created identity's DTO type. | [required] +**id** | **str** | Created identity ID. | [required] +**name** | **str** | Created identity's display name. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.identity_created_identity import IdentityCreatedIdentity + +identity_created_identity = IdentityCreatedIdentity( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20642', +name='Michael Michaels' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityDeleted.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityDeleted.md new file mode 100644 index 000000000..96390ea5a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityDeleted.md @@ -0,0 +1,38 @@ +--- +id: v2024-identity-deleted +title: IdentityDeleted +pagination_label: IdentityDeleted +sidebar_label: IdentityDeleted +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityDeleted', 'V2024IdentityDeleted'] +slug: /tools/sdk/python/v2024/models/identity-deleted +tags: ['SDK', 'Software Development Kit', 'IdentityDeleted', 'V2024IdentityDeleted'] +--- + +# IdentityDeleted + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity** | [**IdentityDeletedIdentity**](identity-deleted-identity) | | [required] +**attributes** | **map[string]object** | The attributes assigned to the identity. Attributes are determined by the identity profile. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.identity_deleted import IdentityDeleted + +identity_deleted = IdentityDeleted( +identity=sailpoint.v2024.models.identity_deleted_identity.IdentityDeleted_identity( + type = 'IDENTITY', + id = '2c7180a46faadee4016fb4e018c20642', + name = 'Michael Michaels', ), +attributes={firstname=John} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityDeletedIdentity.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityDeletedIdentity.md new file mode 100644 index 000000000..3944247ad --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityDeletedIdentity.md @@ -0,0 +1,38 @@ +--- +id: v2024-identity-deleted-identity +title: IdentityDeletedIdentity +pagination_label: IdentityDeletedIdentity +sidebar_label: IdentityDeletedIdentity +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityDeletedIdentity', 'V2024IdentityDeletedIdentity'] +slug: /tools/sdk/python/v2024/models/identity-deleted-identity +tags: ['SDK', 'Software Development Kit', 'IdentityDeletedIdentity', 'V2024IdentityDeletedIdentity'] +--- + +# IdentityDeletedIdentity + +Deleted identity. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'IDENTITY' ] | Deleted identity's DTO type. | [required] +**id** | **str** | Deleted identity ID. | [required] +**name** | **str** | Deleted identity's display name. | [required] +} + +## Example + +```python +from sailpoint.v2024.models.identity_deleted_identity import IdentityDeletedIdentity + +identity_deleted_identity = IdentityDeletedIdentity( +type='IDENTITY', +id='2c7180a46faadee4016fb4e018c20642', +name='Michael Michaels' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityDocument.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityDocument.md new file mode 100644 index 000000000..0cbc68e37 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityDocument.md @@ -0,0 +1,151 @@ +--- +id: v2024-identity-document +title: IdentityDocument +pagination_label: IdentityDocument +sidebar_label: IdentityDocument +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityDocument', 'V2024IdentityDocument'] +slug: /tools/sdk/python/v2024/models/identity-document +tags: ['SDK', 'Software Development Kit', 'IdentityDocument', 'V2024IdentityDocument'] +--- + +# IdentityDocument + +Identity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the referenced object. | [required] +**name** | **str** | The human readable name of the referenced object. | [required] +**display_name** | **str** | Identity's display name. | [optional] +**first_name** | **str** | Identity's first name. | [optional] +**last_name** | **str** | Identity's last name. | [optional] +**email** | **str** | Identity's primary email address. | [optional] +**created** | **datetime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**modified** | **datetime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional] +**phone** | **str** | Identity's phone number. | [optional] +**synced** | **str** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**inactive** | **bool** | Indicates whether the identity is inactive. | [optional] [default to False] +**protected** | **bool** | Indicates whether the identity is protected. | [optional] [default to False] +**status** | **str** | Identity's status in SailPoint. | [optional] +**employee_number** | **str** | Identity's employee number. | [optional] +**manager** | [**IdentityDocumentAllOfManager**](identity-document-all-of-manager) | | [optional] +**is_manager** | **bool** | Indicates whether the identity is a manager of other identities. | [optional] +**identity_profile** | [**IdentityDocumentAllOfIdentityProfile**](identity-document-all-of-identity-profile) | | [optional] +**source** | [**IdentityDocumentAllOfSource**](identity-document-all-of-source) | | [optional] +**attributes** | **map[string]object** | Map or dictionary of key/value pairs. | [optional] +**disabled** | **bool** | Indicates whether the identity is disabled. | [optional] [default to False] +**locked** | **bool** | Indicates whether the identity is locked. | [optional] [default to False] +**processing_state** | **str** | Identity's processing state. | [optional] +**processing_details** | [**ProcessingDetails**](processing-details) | | [optional] +**accounts** | [**[]BaseAccount**](base-account) | List of accounts associated with the identity. | [optional] +**account_count** | **int** | Number of accounts associated with the identity. | [optional] +**apps** | [**[]App**](app) | List of applications the identity has access to. | [optional] +**app_count** | **int** | Number of applications the identity has access to. | [optional] +**access** | [**[]IdentityAccess**](identity-access) | List of access items assigned to the identity. | [optional] +**access_count** | **int** | Number of access items assigned to the identity. | [optional] +**entitlement_count** | **int** | Number of entitlements assigned to the identity. | [optional] +**role_count** | **int** | Number of roles assigned to the identity. | [optional] +**access_profile_count** | **int** | Number of access profiles assigned to the identity. | [optional] +**owns** | [**[]Owns**](owns) | Access items the identity owns. | [optional] +**owns_count** | **int** | Number of access items the identity owns. | [optional] +**tags** | **[]str** | Tags that have been applied to the object. | [optional] +**tags_count** | **int** | Number of tags on the identity. | [optional] +**visible_segments** | **[]str** | List of segments that the identity is in. | [optional] +**visible_segment_count** | **int** | Number of segments the identity is in. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity_document import IdentityDocument + +identity_document = IdentityDocument( +id='2c91808568c529c60168cca6f90c1313', +name='John Doe', +display_name='Carol.Adams', +first_name='Carol', +last_name='Adams', +email='Carol.Adams@sailpointdemo.com', +created='2018-06-25T20:22:28.104Z', +modified='2018-06-25T20:22:28.104Z', +phone='+1 440-527-3672', +synced='', +inactive=False, +protected=False, +status='UNREGISTERED', +employee_number='1a2a3d4e', +manager=sailpoint.v2024.models.identity_document_all_of_manager.IdentityDocument_allOf_manager( + id = '2c9180867dfe694b017e208e27c05799', + name = 'Amanda.Ross', + display_name = 'Amanda.Ross', ), +is_manager=False, +identity_profile=sailpoint.v2024.models.identity_document_all_of_identity_profile.IdentityDocument_allOf_identityProfile( + id = '3bc8ad26b8664945866b31339d1ff7d2', + name = 'HR Employees', ), +source=sailpoint.v2024.models.identity_document_all_of_source.IdentityDocument_allOf_source( + id = '2c91808b6e9e6fb8016eec1a2b6f7b5f', + name = 'ODS-HR-Employees', ), +attributes={country=US, firstname=Carol, cloudStatus=UNREGISTERED}, +disabled=False, +locked=False, +processing_state='ERROR', +processing_details=sailpoint.v2024.models.processing_details.ProcessingDetails( + date = '2018-06-25T20:22:28.104Z', + stage = 'In Process', + retry_count = 0, + stack_trace = '
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-non-employee-source) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | source_id | **str** | True | Source Id + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +### Return type +[**NonEmployeeSource**](../models/non-employee-source) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A patched non-employee source object. | NonEmployeeSource | - | +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 | - | +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-patch+json + - **Accept**: application/json + +### Example + +```python +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.json_patch_operation import JsonPatchOperation +from sailpoint.v3.models.non_employee_source import NonEmployeeSource +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + source_id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id # str | Source Id + json_patch_operation = '''[{op=replace, path=/name, value={new name=null}}, {op=replace, path=/approvers, value=[2c91809f703bb37a017040a2fe8748c7, 48b1f463c9e8427db5a5071bd81914b8]}]''' # List[JsonPatchOperation] | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + try: + # Patch a Non-Employee Source + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_source(source_id=source_id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_source(source_id, new_json_patch_operation) + print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_source:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_source: %s\n" % e) +``` + + + +[[Back to top]](#) + +## reject-non-employee-request +Reject a Non-Employee Request +This endpoint will reject an approval item request and notify user. The current user must be the requested approver. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/reject-non-employee-request) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Non-Employee approval item id (UUID) + Body | non_employee_reject_approval_decision | [**NonEmployeeRejectApprovalDecision**](../models/non-employee-reject-approval-decision) | True | + +### Return type +[**NonEmployeeApprovalItem**](../models/non-employee-approval-item) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Non-Employee approval item object. | NonEmployeeApprovalItem | - | +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 | - | +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 + +```python +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.non_employee_approval_item import NonEmployeeApprovalItem +from sailpoint.v3.models.non_employee_reject_approval_decision import NonEmployeeRejectApprovalDecision +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'e136567de87e4d029e60b3c3c55db56d' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) + non_employee_reject_approval_decision = '''{ + "comment" : "approved" + }''' # NonEmployeeRejectApprovalDecision | + + try: + # Reject a Non-Employee Request + new_non_employee_reject_approval_decision = NonEmployeeRejectApprovalDecision.from_json(non_employee_reject_approval_decision) + results = NonEmployeeLifecycleManagementApi(api_client).reject_non_employee_request(id=id, non_employee_reject_approval_decision=new_non_employee_reject_approval_decision) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).reject_non_employee_request(id, new_non_employee_reject_approval_decision) + print("The response of NonEmployeeLifecycleManagementApi->reject_non_employee_request:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->reject_non_employee_request: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-non-employee-record +Update Non-Employee Record +This request will update a non-employee record. There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:update`, in which case they +update all available fields. + 2. The user is owner of the source, in this case they can only update the +end date. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-non-employee-record) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Non-employee record id (UUID) + Body | non_employee_request_body | [**NonEmployeeRequestBody**](../models/non-employee-request-body) | True | Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + +### Return type +[**NonEmployeeRecord**](../models/non-employee-record) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | An updated non-employee record. | NonEmployeeRecord | - | +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 + +```python +from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.non_employee_record import NonEmployeeRecord +from sailpoint.v3.models.non_employee_request_body import NonEmployeeRequestBody +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-employee record id (UUID) # str | Non-employee record id (UUID) + non_employee_request_body = '''{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + }''' # NonEmployeeRequestBody | Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + + try: + # Update Non-Employee Record + new_non_employee_request_body = NonEmployeeRequestBody.from_json(non_employee_request_body) + results = NonEmployeeLifecycleManagementApi(api_client).update_non_employee_record(id=id, non_employee_request_body=new_non_employee_request_body) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).update_non_employee_record(id, new_non_employee_request_body) + print("The response of NonEmployeeLifecycleManagementApi->update_non_employee_record:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->update_non_employee_record: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/OAuthClientsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/OAuthClientsApi.md new file mode 100644 index 000000000..3db63429f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/OAuthClientsApi.md @@ -0,0 +1,339 @@ +--- +id: o-auth-clients +title: OAuth_Clients +pagination_label: OAuth_Clients +sidebar_label: OAuth_Clients +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'OAuth_Clients', 'OAuth_Clients'] +slug: /tools/sdk/python/v3/methods/o-auth-clients +tags: ['SDK', 'Software Development Kit', 'OAuth_Clients', 'OAuth_Clients'] +--- + +# sailpoint.v3.OAuthClientsApi + Use this API to implement OAuth client functionality. +With this functionality in place, users with the appropriate security scopes can create and configure OAuth clients to use as a way to obtain authorization to use the Identity Security Cloud REST API. +Refer to [Authentication](https://developer.sailpoint.com/docs/api/authentication/) for more information about OAuth and how it works with the Identity Security Cloud REST API. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-oauth-client**](#create-oauth-client) | **POST** `/oauth-clients` | Create OAuth Client +[**delete-oauth-client**](#delete-oauth-client) | **DELETE** `/oauth-clients/{id}` | Delete OAuth Client +[**get-oauth-client**](#get-oauth-client) | **GET** `/oauth-clients/{id}` | Get OAuth Client +[**list-oauth-clients**](#list-oauth-clients) | **GET** `/oauth-clients` | List OAuth Clients +[**patch-oauth-client**](#patch-oauth-client) | **PATCH** `/oauth-clients/{id}` | Patch OAuth Client + + +## create-oauth-client +Create OAuth Client +This creates an OAuth client. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-oauth-client) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | create_o_auth_client_request | [**CreateOAuthClientRequest**](../models/create-o-auth-client-request) | True | + +### Return type +[**CreateOAuthClientResponse**](../models/create-o-auth-client-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Request succeeded. | CreateOAuthClientResponse | - | +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 | - | +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 + +```python +from sailpoint.v3.api.o_auth_clients_api import OAuthClientsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.create_o_auth_client_request import CreateOAuthClientRequest +from sailpoint.v3.models.create_o_auth_client_response import CreateOAuthClientResponse +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + create_o_auth_client_request = '''{ + "internal" : false, + "businessName" : "Acme-Solar", + "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", + "refreshTokenValiditySeconds" : 86400, + "type" : "CONFIDENTIAL", + "redirectUris" : [ "http://localhost:12345" ], + "enabled" : true, + "accessType" : "OFFLINE", + "grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ], + "strongAuthSupported" : false, + "homepageUrl" : "http://localhost:12345", + "accessTokenValiditySeconds" : 750, + "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], + "name" : "Demo API Client", + "claimsSupported" : false + }''' # CreateOAuthClientRequest | + + try: + # Create OAuth Client + new_create_o_auth_client_request = CreateOAuthClientRequest.from_json(create_o_auth_client_request) + results = OAuthClientsApi(api_client).create_oauth_client(create_o_auth_client_request=new_create_o_auth_client_request) + # Below is a request that includes all optional parameters + # results = OAuthClientsApi(api_client).create_oauth_client(new_create_o_auth_client_request) + print("The response of OAuthClientsApi->create_oauth_client:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling OAuthClientsApi->create_oauth_client: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-oauth-client +Delete OAuth Client +This deletes an OAuth client. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-oauth-client) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The OAuth client id + +### 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. | 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 + +```python +from sailpoint.v3.api.o_auth_clients_api import OAuthClientsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id + + try: + # Delete OAuth Client + + OAuthClientsApi(api_client).delete_oauth_client(id=id) + # Below is a request that includes all optional parameters + # OAuthClientsApi(api_client).delete_oauth_client(id) + except Exception as e: + print("Exception when calling OAuthClientsApi->delete_oauth_client: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-oauth-client +Get OAuth Client +This gets details of an OAuth client. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-oauth-client) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The OAuth client id + +### Return type +[**GetOAuthClientResponse**](../models/get-o-auth-client-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Request succeeded. | GetOAuthClientResponse | - | +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 + +```python +from sailpoint.v3.api.o_auth_clients_api import OAuthClientsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.get_o_auth_client_response import GetOAuthClientResponse +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id + + try: + # Get OAuth Client + + results = OAuthClientsApi(api_client).get_oauth_client(id=id) + # Below is a request that includes all optional parameters + # results = OAuthClientsApi(api_client).get_oauth_client(id) + print("The response of OAuthClientsApi->get_oauth_client:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling OAuthClientsApi->get_oauth_client: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-oauth-clients +List OAuth Clients +This gets a list of OAuth clients. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-oauth-clients) + +### 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* + +### Return type +[**List[GetOAuthClientResponse]**](../models/get-o-auth-client-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of OAuth clients. | List[GetOAuthClientResponse] | - | +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 | - | +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 + +```python +from sailpoint.v3.api.o_auth_clients_api import OAuthClientsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.get_o_auth_client_response import GetOAuthClientResponse +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # 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: **lastUsed**: *le, isnull* (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: **lastUsed**: *le, isnull* (optional) + + try: + # List OAuth Clients + + results = OAuthClientsApi(api_client).list_oauth_clients() + # Below is a request that includes all optional parameters + # results = OAuthClientsApi(api_client).list_oauth_clients(filters) + print("The response of OAuthClientsApi->list_oauth_clients:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-oauth-client +Patch OAuth Client +This performs a targeted update to the field(s) of an OAuth client. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-oauth-client) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The OAuth client id + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported + +### Return type +[**GetOAuthClientResponse**](../models/get-o-auth-client-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Indicates the PATCH operation succeeded, and returns the OAuth client's new representation. | GetOAuthClientResponse | - | +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-patch+json + - **Accept**: application/json + +### Example + +```python +from sailpoint.v3.api.o_auth_clients_api import OAuthClientsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.get_o_auth_client_response import GetOAuthClientResponse +from sailpoint.v3.models.json_patch_operation import JsonPatchOperation +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id + json_patch_operation = '''[{op=replace, path=/strongAuthSupported, value=true}, {op=replace, path=/businessName, value=acme-solar}]''' # List[JsonPatchOperation] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported + + try: + # Patch OAuth Client + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = OAuthClientsApi(api_client).patch_oauth_client(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = OAuthClientsApi(api_client).patch_oauth_client(id, new_json_patch_operation) + print("The response of OAuthClientsApi->patch_oauth_client:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling OAuthClientsApi->patch_oauth_client: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/PasswordConfigurationApi.md b/docs/tools/sdk/python/Reference/V3/Methods/PasswordConfigurationApi.md new file mode 100644 index 000000000..f01c43c0d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/PasswordConfigurationApi.md @@ -0,0 +1,214 @@ +--- +id: password-configuration +title: Password_Configuration +pagination_label: Password_Configuration +sidebar_label: Password_Configuration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Password_Configuration', 'Password_Configuration'] +slug: /tools/sdk/python/v3/methods/password-configuration +tags: ['SDK', 'Software Development Kit', 'Password_Configuration', 'Password_Configuration'] +--- + +# sailpoint.v3.PasswordConfigurationApi + Use this API to implement organization password configuration functionality. +With this functionality in place, organization administrators can create organization-specific password configurations. + +These configurations include details like custom password instructions, as well as digit token length and duration. + +Refer to [Configuring User Authentication for Password Resets](https://documentation.sailpoint.com/saas/help/pwd/pwd_reset.html) for more information about organization password configuration functionality. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-password-org-config**](#create-password-org-config) | **POST** `/password-org-config` | Create Password Org Config +[**get-password-org-config**](#get-password-org-config) | **GET** `/password-org-config` | Get Password Org Config +[**put-password-org-config**](#put-password-org-config) | **PUT** `/password-org-config` | Update Password Org Config + + +## create-password-org-config +Create Password Org Config +This API creates the password org config. Unspecified fields will use default value. +To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to "true". +Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-password-org-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | password_org_config | [**PasswordOrgConfig**](../models/password-org-config) | True | + +### Return type +[**PasswordOrgConfig**](../models/password-org-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Reference to the password org config. | PasswordOrgConfig | - | +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 | - | +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 + +```python +from sailpoint.v3.api.password_configuration_api import PasswordConfigurationApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.password_org_config import PasswordOrgConfig +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + password_org_config = '''{ + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + }''' # PasswordOrgConfig | + + try: + # Create Password Org Config + new_password_org_config = PasswordOrgConfig.from_json(password_org_config) + results = PasswordConfigurationApi(api_client).create_password_org_config(password_org_config=new_password_org_config) + # Below is a request that includes all optional parameters + # results = PasswordConfigurationApi(api_client).create_password_org_config(new_password_org_config) + print("The response of PasswordConfigurationApi->create_password_org_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordConfigurationApi->create_password_org_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-password-org-config +Get Password Org Config +This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-password-org-config) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**PasswordOrgConfig**](../models/password-org-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Reference to the password org config. | PasswordOrgConfig | - | +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 | - | +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 + +```python +from sailpoint.v3.api.password_configuration_api import PasswordConfigurationApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.password_org_config import PasswordOrgConfig +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + + try: + # Get Password Org Config + + results = PasswordConfigurationApi(api_client).get_password_org_config() + # Below is a request that includes all optional parameters + # results = PasswordConfigurationApi(api_client).get_password_org_config() + print("The response of PasswordConfigurationApi->get_password_org_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordConfigurationApi->get_password_org_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-password-org-config +Update Password Org Config +This API updates the password org config for specified fields. Other fields will keep original value. +You must set the `customInstructionsEnabled` field to "true" to be able to use custom password instructions. +Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' + +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-password-org-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | password_org_config | [**PasswordOrgConfig**](../models/password-org-config) | True | + +### Return type +[**PasswordOrgConfig**](../models/password-org-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Reference to the password org config. | PasswordOrgConfig | - | +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 | - | +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 + +```python +from sailpoint.v3.api.password_configuration_api import PasswordConfigurationApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.password_org_config import PasswordOrgConfig +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + password_org_config = '''{ + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + }''' # PasswordOrgConfig | + + try: + # Update Password Org Config + new_password_org_config = PasswordOrgConfig.from_json(password_org_config) + results = PasswordConfigurationApi(api_client).put_password_org_config(password_org_config=new_password_org_config) + # Below is a request that includes all optional parameters + # results = PasswordConfigurationApi(api_client).put_password_org_config(new_password_org_config) + print("The response of PasswordConfigurationApi->put_password_org_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordConfigurationApi->put_password_org_config: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/PasswordDictionaryApi.md b/docs/tools/sdk/python/Reference/V3/Methods/PasswordDictionaryApi.md new file mode 100644 index 000000000..77001cc63 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/PasswordDictionaryApi.md @@ -0,0 +1,237 @@ +--- +id: password-dictionary +title: Password_Dictionary +pagination_label: Password_Dictionary +sidebar_label: Password_Dictionary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Password_Dictionary', 'Password_Dictionary'] +slug: /tools/sdk/python/v3/methods/password-dictionary +tags: ['SDK', 'Software Development Kit', 'Password_Dictionary', 'Password_Dictionary'] +--- + +# sailpoint.v3.PasswordDictionaryApi + Use this API to implement password dictionary functionality. +With this functionality in place, administrators can create password dictionaries to prevent users from using certain words or characters in their passwords. + +A password dictionary is a list of words or characters that users are prevented from including in their passwords. +This can help protect users from themselves and force them to create passwords that are not easy to break. + +A password dictionary must meet the following requirements to for the API to handle them correctly: + +- It must be in .txt format. + +- All characters must be UTF-8 characters. + +- Each line must contain a single word or character with no spaces or whitespace characters. + +- It must contain at least one line other than the locale string. + +- Each line must not exceed 128 characters. + +- The file must not exceed 2500 lines. + +Administrators should also consider the following when they create their dictionaries: + +- Lines starting with a # represent comments. + +- All words in the password dictionary are case-insensitive. +For example, adding the word "password" to the dictionary also disallows the following: PASSWORD, Password, and PassWord. + +- The dictionary uses substring matching. +For example, adding the word "spring" to the dictionary also disallows the following: Spring124, 345SprinG, and 8spring. +Users can then select 'Change Password' to update their passwords. + +Administrators must do the following to create a password dictionary: + +- Create the text file that will contain the prohibited password values. + +- If the dictionary is not in English, they must add a locale string to the top line: locale:`languageCode`_`countryCode` + +The languageCode value refers to the language's 2-letter ISO 639-1 code. +The countryCode value refers to the country's 2-letter ISO 3166-1 code. + +Refer to this list https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html to see all the available ISO 639-1 language codes and ISO 3166-1 country codes. + +- Upload the .txt file to Identity Security Cloud with [Update Password Dictionary](https://developer.sailpoint.com/docs/api/v3/put-password-dictionary). Uploading a new file always overwrites the previous dictionary file. + +Administrators can then specify which password policies check new passwords against the password dictionary by doing the following: In the Admin panel, they can use the Password Mgmt dropdown menu to select Policies, select the policy, and select the 'Prevent use of words in this site's password dictionary' checkbox beside it. + +Refer to [Configuring Advanced Password Management Options](https://documentation.sailpoint.com/saas/help/pwd/adv_config.html) for more information about password dictionaries. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-password-dictionary**](#get-password-dictionary) | **GET** `/password-dictionary` | Get Password Dictionary +[**put-password-dictionary**](#put-password-dictionary) | **PUT** `/password-dictionary` | Update Password Dictionary + + +## get-password-dictionary +Get Password Dictionary +This gets password dictionary for the organization. +The password dictionary file can contain lines that are: +1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing +2. empty lines +3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines +4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; + maximum length of the line is 128 Unicode codepoints + + +Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). + Password dict file must contain UTF-8 characters only. + +# Sample password text file + +``` + +# Password dictionary small test file + +locale=en_US + +# Password dictionary prohibited words + +qwerty +abcd +aaaaa +password +qazxsws + +``` + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-password-dictionary) + +### Parameters +This endpoint does not need any parameter. + +### Return type +**str** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A password dictionary response | 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. | 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**: text/plain, application/json + +### Example + +```python +from sailpoint.v3.api.password_dictionary_api import PasswordDictionaryApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + + try: + # Get Password Dictionary + + results = PasswordDictionaryApi(api_client).get_password_dictionary() + # Below is a request that includes all optional parameters + # results = PasswordDictionaryApi(api_client).get_password_dictionary() + print("The response of PasswordDictionaryApi->get_password_dictionary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordDictionaryApi->get_password_dictionary: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-password-dictionary +Update Password Dictionary +This updates password dictionary for the organization. +The password dictionary file can contain lines that are: +1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing +2. empty lines +3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines +4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; + maximum length of the line is 128 Unicode codepoints + + +Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). + Password dict file must contain UTF-8 characters only. + +# Sample password text file + +``` + +# Password dictionary small test file + +locale=en_US + +# Password dictionary prohibited words + +qwerty +abcd +aaaaa +password +qazxsws + +``` + +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-password-dictionary) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | file | **bytearray** | (optional) | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Successfully updated. | | - | +201 | Created. | | - | +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**: multipart/form-data + - **Accept**: application/json + +### Example + +```python +from sailpoint.v3.api.password_dictionary_api import PasswordDictionaryApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + file = None # bytearray | (optional) # bytearray | (optional) + + try: + # Update Password Dictionary + + PasswordDictionaryApi(api_client).put_password_dictionary() + # Below is a request that includes all optional parameters + # PasswordDictionaryApi(api_client).put_password_dictionary(file) + except Exception as e: + print("Exception when calling PasswordDictionaryApi->put_password_dictionary: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/PasswordManagementApi.md b/docs/tools/sdk/python/Reference/V3/Methods/PasswordManagementApi.md new file mode 100644 index 000000000..a54717e07 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/PasswordManagementApi.md @@ -0,0 +1,254 @@ +--- +id: password-management +title: Password_Management +pagination_label: Password_Management +sidebar_label: Password_Management +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Password_Management', 'Password_Management'] +slug: /tools/sdk/python/v3/methods/password-management +tags: ['SDK', 'Software Development Kit', 'Password_Management', 'Password_Management'] +--- + +# sailpoint.v3.PasswordManagementApi + Use this API to implement password management functionality. +With this functionality in place, users can manage their identity passwords for all their applications. + +In Identity Security Cloud, users can select their names in the upper right corner of the page and use the drop-down menu to select Password Manager. +Password Manager lists the user's identity's applications, possibly grouped to share passwords. +Users can then select 'Change Password' to update their passwords. + +Grouping passwords allows users to update their passwords more broadly, rather than requiring them to update each password individually. +Password Manager may list the applications and sources in the following groups: + +- Password Group: This refers to a group of applications that share a password. +For example, a user can use the same password for Google Drive, Google Mail, and YouTube. +Updating the password for the password group updates the password for all its included applications. + +- Multi-Application Source: This refers to a source with multiple applications that share a password. +For example, a user can have a source, G Suite, that includes the Google Calendar, Google Drive, and Google Mail applications. +Updating the password for the multi-application source updates the password for all its included applications. + +- Applications: These are applications that do not share passwords with other applications. + +An organization may require some authentication for users to update their passwords. +Users may be required to answer security questions or use a third-party authenticator before they can confirm their updates. + +Refer to [Managing Passwords](https://documentation.sailpoint.com/saas/user-help/accounts/passwords.html) for more information about password management. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-password-change-status**](#get-password-change-status) | **GET** `/password-change-status/{id}` | Get Password Change Request Status +[**query-password-info**](#query-password-info) | **POST** `/query-password-info` | Query Password Info +[**set-password**](#set-password) | **POST** `/set-password` | Set Identity's Password + + +## get-password-change-status +Get Password Change Request Status +This API returns the status of a password change request. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-password-change-status) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Password change request ID + +### Return type +[**PasswordStatus**](../models/password-status) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Status of the password change request | PasswordStatus | - | +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 + +```python +from sailpoint.v3.api.password_management_api import PasswordManagementApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.password_status import PasswordStatus +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = '089899f13a8f4da7824996191587bab9' # str | Password change request ID # str | Password change request ID + + try: + # Get Password Change Request Status + + results = PasswordManagementApi(api_client).get_password_change_status(id=id) + # Below is a request that includes all optional parameters + # results = PasswordManagementApi(api_client).get_password_change_status(id) + print("The response of PasswordManagementApi->get_password_change_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordManagementApi->get_password_change_status: %s\n" % e) +``` + + + +[[Back to top]](#) + +## query-password-info +Query Password Info +This API is used to query password related information. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/query-password-info) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | password_info_query_dto | [**PasswordInfoQueryDTO**](../models/password-info-query-dto) | True | + +### Return type +[**PasswordInfo**](../models/password-info) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Reference to the password info. | PasswordInfo | - | +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 | - | +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 + +```python +from sailpoint.v3.api.password_management_api import PasswordManagementApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.password_info import PasswordInfo +from sailpoint.v3.models.password_info_query_dto import PasswordInfoQueryDTO +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + password_info_query_dto = '''{ + "sourceName" : "My-AD", + "userName" : "Abby.Smith" + }''' # PasswordInfoQueryDTO | + + try: + # Query Password Info + new_password_info_query_dto = PasswordInfoQueryDto.from_json(password_info_query_dto) + results = PasswordManagementApi(api_client).query_password_info(password_info_query_dto=new_password_info_query_dto) + # Below is a request that includes all optional parameters + # results = PasswordManagementApi(api_client).query_password_info(new_password_info_query_dto) + print("The response of PasswordManagementApi->query_password_info:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordManagementApi->query_password_info: %s\n" % e) +``` + + + +[[Back to top]](#) + +## set-password +Set Identity's Password +This API is used to set a password for an identity. + +An identity can change their own password (as well as any of their accounts' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or ["authorization_code" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). + +>**Note: If you want to set an identity's source account password, you must enable `PASSWORD` as one of the source's features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** + +To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: + +```bash +echo -n "myPassword" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 +``` + +In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. + +To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. + +If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. + +You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/set-password) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | password_change_request | [**PasswordChangeRequest**](../models/password-change-request) | True | + +### Return type +[**PasswordChangeResponse**](../models/password-change-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Reference to the password change. | PasswordChangeResponse | - | +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 | - | +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 + +```python +from sailpoint.v3.api.password_management_api import PasswordManagementApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.password_change_request import PasswordChangeRequest +from sailpoint.v3.models.password_change_response import PasswordChangeResponse +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + password_change_request = '''{ + "sourceId" : "8a807d4c73c545510173c545d4b60246", + "accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", + "identityId" : "8a807d4c73c545510173c545f0a002ff", + "publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", + "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" + }''' # PasswordChangeRequest | + + try: + # Set Identity's Password + new_password_change_request = PasswordChangeRequest.from_json(password_change_request) + results = PasswordManagementApi(api_client).set_password(password_change_request=new_password_change_request) + # Below is a request that includes all optional parameters + # results = PasswordManagementApi(api_client).set_password(new_password_change_request) + print("The response of PasswordManagementApi->set_password:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordManagementApi->set_password: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/PasswordPoliciesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/PasswordPoliciesApi.md new file mode 100644 index 000000000..98034eddd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/PasswordPoliciesApi.md @@ -0,0 +1,396 @@ +--- +id: password-policies +title: Password_Policies +pagination_label: Password_Policies +sidebar_label: Password_Policies +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Password_Policies', 'Password_Policies'] +slug: /tools/sdk/python/v3/methods/password-policies +tags: ['SDK', 'Software Development Kit', 'Password_Policies', 'Password_Policies'] +--- + +# sailpoint.v3.PasswordPoliciesApi + Use these APIs to implement password policies functionality. +These APIs allow you to define the policy parameters for choosing passwords. + +IdentityNow comes with a default policy that you can modify to define the password requirements your users must meet to log in to IdentityNow, such as requiring a minimum password length, including special characters, and disallowing certain patterns. +If you have licensed Password Management, you can create additional password policies beyond the default one to manage passwords for supported sources in your org. + +In the Identity Security Cloud Admin panel, administrators can use the Password Mgmt dropdown menu to select Sync Groups. +Refer to [Managing Password Policies](https://documentation.sailpoint.com/saas/help/pwd/pwd_policies/pwd_policies.html) for more information about password policies. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-password-policy**](#create-password-policy) | **POST** `/password-policies` | Create Password Policy +[**delete-password-policy**](#delete-password-policy) | **DELETE** `/password-policies/{id}` | Delete Password Policy by ID +[**get-password-policy-by-id**](#get-password-policy-by-id) | **GET** `/password-policies/{id}` | Get Password Policy by ID +[**list-password-policies**](#list-password-policies) | **GET** `/password-policies` | List Password Policies +[**set-password-policy**](#set-password-policy) | **PUT** `/password-policies/{id}` | Update Password Policy by ID + + +## create-password-policy +Create Password Policy +This API creates the specified password policy. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-password-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | password_policy_v3_dto | [**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) | True | + +### Return type +[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Reference to the password policy. | PasswordPolicyV3Dto | - | +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 + +```python +from sailpoint.v3.api.password_policies_api import PasswordPoliciesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.password_policy_v3_dto import PasswordPolicyV3Dto +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + password_policy_v3_dto = '''{ + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : "2000-01-23T04:56:07.000+00:00", + "validateAgainstAccountId" : false, + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + }''' # PasswordPolicyV3Dto | + + try: + # Create Password Policy + new_password_policy_v3_dto = PasswordPolicyV3Dto.from_json(password_policy_v3_dto) + results = PasswordPoliciesApi(api_client).create_password_policy(password_policy_v3_dto=new_password_policy_v3_dto) + # Below is a request that includes all optional parameters + # results = PasswordPoliciesApi(api_client).create_password_policy(new_password_policy_v3_dto) + print("The response of PasswordPoliciesApi->create_password_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->create_password_policy: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-password-policy +Delete Password Policy by ID +This API deletes the specified password policy. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-password-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of password policy to delete. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +204 | No content - indicates the request was successful but there is no content to be returned in the response. | | - | +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 + +```python +from sailpoint.v3.api.password_policies_api import PasswordPoliciesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ff808081838d9e9d01838da6a03e0002' # str | The ID of password policy to delete. # str | The ID of password policy to delete. + + try: + # Delete Password Policy by ID + + PasswordPoliciesApi(api_client).delete_password_policy(id=id) + # Below is a request that includes all optional parameters + # PasswordPoliciesApi(api_client).delete_password_policy(id) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->delete_password_policy: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-password-policy-by-id +Get Password Policy by ID +This API returns the password policy for the specified ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-password-policy-by-id) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of password policy to retrieve. + +### Return type +[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Reference to the password policy. | PasswordPolicyV3Dto | - | +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 + +```python +from sailpoint.v3.api.password_policies_api import PasswordPoliciesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.password_policy_v3_dto import PasswordPolicyV3Dto +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ff808081838d9e9d01838da6a03e0005' # str | The ID of password policy to retrieve. # str | The ID of password policy to retrieve. + + try: + # Get Password Policy by ID + + results = PasswordPoliciesApi(api_client).get_password_policy_by_id(id=id) + # Below is a request that includes all optional parameters + # results = PasswordPoliciesApi(api_client).get_password_policy_by_id(id) + print("The response of PasswordPoliciesApi->get_password_policy_by_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->get_password_policy_by_id: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-password-policies +List Password Policies +This gets list of all Password Policies. +Requires role of ORG_ADMIN + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-password-policies) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + 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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**List[PasswordPolicyV3Dto]**](../models/password-policy-v3-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of all Password Policies. | List[PasswordPolicyV3Dto] | - | +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 | - | +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 + +```python +from sailpoint.v3.api.password_policies_api import PasswordPoliciesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.password_policy_v3_dto import PasswordPolicyV3Dto +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + 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 Password Policies + + results = PasswordPoliciesApi(api_client).list_password_policies() + # Below is a request that includes all optional parameters + # results = PasswordPoliciesApi(api_client).list_password_policies(limit, offset, count) + print("The response of PasswordPoliciesApi->list_password_policies:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->list_password_policies: %s\n" % e) +``` + + + +[[Back to top]](#) + +## set-password-policy +Update Password Policy by ID +This API updates the specified password policy. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/set-password-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of password policy to update. + Body | password_policy_v3_dto | [**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) | True | + +### Return type +[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Reference to the password policy. | PasswordPolicyV3Dto | - | +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 + +```python +from sailpoint.v3.api.password_policies_api import PasswordPoliciesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.password_policy_v3_dto import PasswordPolicyV3Dto +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ff808081838d9e9d01838da6a03e0007' # str | The ID of password policy to update. # str | The ID of password policy to update. + password_policy_v3_dto = '''{ + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : "2000-01-23T04:56:07.000+00:00", + "validateAgainstAccountId" : false, + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + }''' # PasswordPolicyV3Dto | + + try: + # Update Password Policy by ID + new_password_policy_v3_dto = PasswordPolicyV3Dto.from_json(password_policy_v3_dto) + results = PasswordPoliciesApi(api_client).set_password_policy(id=id, password_policy_v3_dto=new_password_policy_v3_dto) + # Below is a request that includes all optional parameters + # results = PasswordPoliciesApi(api_client).set_password_policy(id, new_password_policy_v3_dto) + print("The response of PasswordPoliciesApi->set_password_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->set_password_policy: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/PasswordSyncGroupsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/PasswordSyncGroupsApi.md new file mode 100644 index 000000000..504465b9f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/PasswordSyncGroupsApi.md @@ -0,0 +1,367 @@ +--- +id: password-sync-groups +title: Password_Sync_Groups +pagination_label: Password_Sync_Groups +sidebar_label: Password_Sync_Groups +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Password_Sync_Groups', 'Password_Sync_Groups'] +slug: /tools/sdk/python/v3/methods/password-sync-groups +tags: ['SDK', 'Software Development Kit', 'Password_Sync_Groups', 'Password_Sync_Groups'] +--- + +# sailpoint.v3.PasswordSyncGroupsApi + Use this API to implement password sync group functionality. +With this functionality in place, administrators can group sources into password sync groups so that all their applications share the same password. +This allows users to update the password for all the applications in a sync group if they want, rather than updating each password individually. + +A password sync group is a group of applications that shares a password. +Administrators create these groups by grouping the applications' sources. +For example, an administrator can group the ActiveDirectory, GitHub, and G Suite sources together so that all those sources' applications can also be grouped to share a password. +A user can then update his or her password for ActiveDirectory, GitHub, Gmail, Google Drive, and Google Calendar all at once, rather then updating each one individually. + +The following are required for administrators to create a password sync group in Identity Security Cloud: + +- At least two direct connect sources connected to Identity Security Cloud and configured for Password Management. + +- Each authentication source in a sync group must have at least one application. Refer to [Adding and Resetting Application Passwords](https://documentation.sailpoint.com/saas/help/pwd/adv_config.html#adding-and-resetting-application-passwords) for more information about adding applications to sources. + +- At least one password policy. Refer to [Managing Password Policies](https://documentation.sailpoint.com/saas/help/pwd/policies.html) for more information about password policies. + +In the Admin panel in Identity Security Cloud, administrators can use the Password Mgmt dropdown menu to select Sync Groups. +To create a sync group, administrators must provide a name, choose a password policy to be enforced across the sources in the sync group, and select the sources to include in the sync group. + +Administrators can also delete sync groups in Identity Security Cloud, but they should know the following before they do: + +- Passwords related to the associated sources will become independent, so changing one will not change the others anymore. + +- Passwords for the sources' connected applications will also become independent. + +- Password policies assigned to the sync group are then assigned directly to the associated sources. +To change the password policy for a source, administrators must edit it directly. + +Once the password sync group has been created, users can update the password for the group in Password Manager. + +Refer to [Managing Password Sync Groups](https://documentation.sailpoint.com/saas/help/pwd/sync_grps.html) for more information about password sync groups. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-password-sync-group**](#create-password-sync-group) | **POST** `/password-sync-groups` | Create Password Sync Group +[**delete-password-sync-group**](#delete-password-sync-group) | **DELETE** `/password-sync-groups/{id}` | Delete Password Sync Group by ID +[**get-password-sync-group**](#get-password-sync-group) | **GET** `/password-sync-groups/{id}` | Get Password Sync Group by ID +[**get-password-sync-groups**](#get-password-sync-groups) | **GET** `/password-sync-groups` | Get Password Sync Group List +[**update-password-sync-group**](#update-password-sync-group) | **PUT** `/password-sync-groups/{id}` | Update Password Sync Group by ID + + +## create-password-sync-group +Create Password Sync Group +This API creates a password sync group based on the specifications provided. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-password-sync-group) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | password_sync_group | [**PasswordSyncGroup**](../models/password-sync-group) | True | + +### Return type +[**PasswordSyncGroup**](../models/password-sync-group) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Reference to the password sync group. | PasswordSyncGroup | - | +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 | - | +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 + +```python +from sailpoint.v3.api.password_sync_groups_api import PasswordSyncGroupsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.password_sync_group import PasswordSyncGroup +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + password_sync_group = '''{ + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }''' # PasswordSyncGroup | + + try: + # Create Password Sync Group + new_password_sync_group = PasswordSyncGroup.from_json(password_sync_group) + results = PasswordSyncGroupsApi(api_client).create_password_sync_group(password_sync_group=new_password_sync_group) + # Below is a request that includes all optional parameters + # results = PasswordSyncGroupsApi(api_client).create_password_sync_group(new_password_sync_group) + print("The response of PasswordSyncGroupsApi->create_password_sync_group:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->create_password_sync_group: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-password-sync-group +Delete Password Sync Group by ID +This API deletes the specified password sync group. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-password-sync-group) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of password sync group to delete. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +204 | No content - indicates the request was successful but there is no content to be returned in the response. | | - | +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 | - | +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 + +```python +from sailpoint.v3.api.password_sync_groups_api import PasswordSyncGroupsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = '6881f631-3bd5-4213-9c75-8e05cc3e35dd' # str | The ID of password sync group to delete. # str | The ID of password sync group to delete. + + try: + # Delete Password Sync Group by ID + + PasswordSyncGroupsApi(api_client).delete_password_sync_group(id=id) + # Below is a request that includes all optional parameters + # PasswordSyncGroupsApi(api_client).delete_password_sync_group(id) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->delete_password_sync_group: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-password-sync-group +Get Password Sync Group by ID +This API returns the sync group for the specified ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-password-sync-group) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of password sync group to retrieve. + +### Return type +[**PasswordSyncGroup**](../models/password-sync-group) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Reference to the password sync group. | PasswordSyncGroup | - | +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 + +```python +from sailpoint.v3.api.password_sync_groups_api import PasswordSyncGroupsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.password_sync_group import PasswordSyncGroup +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = '6881f631-3bd5-4213-9c75-8e05cc3e35dd' # str | The ID of password sync group to retrieve. # str | The ID of password sync group to retrieve. + + try: + # Get Password Sync Group by ID + + results = PasswordSyncGroupsApi(api_client).get_password_sync_group(id=id) + # Below is a request that includes all optional parameters + # results = PasswordSyncGroupsApi(api_client).get_password_sync_group(id) + print("The response of PasswordSyncGroupsApi->get_password_sync_group:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->get_password_sync_group: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-password-sync-groups +Get Password Sync Group List +This API returns a list of password sync groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-password-sync-groups) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + 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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**List[PasswordSyncGroup]**](../models/password-sync-group) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of password sync groups. | List[PasswordSyncGroup] | - | +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 | - | +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 + +```python +from sailpoint.v3.api.password_sync_groups_api import PasswordSyncGroupsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.password_sync_group import PasswordSyncGroup +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + 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: + # Get Password Sync Group List + + results = PasswordSyncGroupsApi(api_client).get_password_sync_groups() + # Below is a request that includes all optional parameters + # results = PasswordSyncGroupsApi(api_client).get_password_sync_groups(limit, offset, count) + print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->get_password_sync_groups: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-password-sync-group +Update Password Sync Group by ID +This API updates the specified password sync group. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-password-sync-group) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of password sync group to update. + Body | password_sync_group | [**PasswordSyncGroup**](../models/password-sync-group) | True | + +### Return type +[**PasswordSyncGroup**](../models/password-sync-group) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Reference to the password sync group. | PasswordSyncGroup | - | +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 + +```python +from sailpoint.v3.api.password_sync_groups_api import PasswordSyncGroupsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.password_sync_group import PasswordSyncGroup +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = '6881f631-3bd5-4213-9c75-8e05cc3e35dd' # str | The ID of password sync group to update. # str | The ID of password sync group to update. + password_sync_group = '''{ + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }''' # PasswordSyncGroup | + + try: + # Update Password Sync Group by ID + new_password_sync_group = PasswordSyncGroup.from_json(password_sync_group) + results = PasswordSyncGroupsApi(api_client).update_password_sync_group(id=id, password_sync_group=new_password_sync_group) + # Below is a request that includes all optional parameters + # results = PasswordSyncGroupsApi(api_client).update_password_sync_group(id, new_password_sync_group) + print("The response of PasswordSyncGroupsApi->update_password_sync_group:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->update_password_sync_group: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/PersonalAccessTokensApi.md b/docs/tools/sdk/python/Reference/V3/Methods/PersonalAccessTokensApi.md new file mode 100644 index 000000000..cd23f309a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/PersonalAccessTokensApi.md @@ -0,0 +1,278 @@ +--- +id: personal-access-tokens +title: Personal_Access_Tokens +pagination_label: Personal_Access_Tokens +sidebar_label: Personal_Access_Tokens +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Personal_Access_Tokens', 'Personal_Access_Tokens'] +slug: /tools/sdk/python/v3/methods/personal-access-tokens +tags: ['SDK', 'Software Development Kit', 'Personal_Access_Tokens', 'Personal_Access_Tokens'] +--- + +# sailpoint.v3.PersonalAccessTokensApi + Use this API to implement personal access token (PAT) functionality. +With this functionality in place, users can use PATs as an alternative to passwords for authentication in Identity Security Cloud. + +PATs embed user information into the client ID and secret. +This replaces the API clients' need to store and provide a username and password to establish a connection, improving Identity Security Cloud organizations' integration security. + +In Identity Security Cloud, users can do the following to create and manage their PATs: Select the dropdown menu under their names, select Preferences, and then select Personal Access Tokens. +They must then provide a description about the token's purpose. +They can then select 'Create Token' at the bottom of the page to generate and view the Secret and Client ID. + +Refer to [Managing Personal Access Tokens](https://documentation.sailpoint.com/saas/help/common/generate_tokens.html) for more information about PATs. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-personal-access-token**](#create-personal-access-token) | **POST** `/personal-access-tokens` | Create Personal Access Token +[**delete-personal-access-token**](#delete-personal-access-token) | **DELETE** `/personal-access-tokens/{id}` | Delete Personal Access Token +[**list-personal-access-tokens**](#list-personal-access-tokens) | **GET** `/personal-access-tokens` | List Personal Access Tokens +[**patch-personal-access-token**](#patch-personal-access-token) | **PATCH** `/personal-access-tokens/{id}` | Patch Personal Access Token + + +## create-personal-access-token +Create Personal Access Token +This creates a personal access token. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-personal-access-token) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | create_personal_access_token_request | [**CreatePersonalAccessTokenRequest**](../models/create-personal-access-token-request) | True | Name and scope of personal access token. + +### Return type +[**CreatePersonalAccessTokenResponse**](../models/create-personal-access-token-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Created. Note - this is the only time Personal Access Tokens' secret attribute will be displayed. | CreatePersonalAccessTokenResponse | - | +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 | - | +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 + +```python +from sailpoint.v3.api.personal_access_tokens_api import PersonalAccessTokensApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.create_personal_access_token_request import CreatePersonalAccessTokenRequest +from sailpoint.v3.models.create_personal_access_token_response import CreatePersonalAccessTokenResponse +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + create_personal_access_token_request = '''{ + "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], + "accessTokenValiditySeconds" : 36900, + "name" : "NodeJS Integration" + }''' # CreatePersonalAccessTokenRequest | Name and scope of personal access token. + + try: + # Create Personal Access Token + new_create_personal_access_token_request = CreatePersonalAccessTokenRequest.from_json(create_personal_access_token_request) + results = PersonalAccessTokensApi(api_client).create_personal_access_token(create_personal_access_token_request=new_create_personal_access_token_request) + # Below is a request that includes all optional parameters + # results = PersonalAccessTokensApi(api_client).create_personal_access_token(new_create_personal_access_token_request) + print("The response of PersonalAccessTokensApi->create_personal_access_token:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->create_personal_access_token: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-personal-access-token +Delete Personal Access Token +This deletes a personal access token. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-personal-access-token) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The personal access token id + +### 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. | 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 + +```python +from sailpoint.v3.api.personal_access_tokens_api import PersonalAccessTokensApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The personal access token id # str | The personal access token id + + try: + # Delete Personal Access Token + + PersonalAccessTokensApi(api_client).delete_personal_access_token(id=id) + # Below is a request that includes all optional parameters + # PersonalAccessTokensApi(api_client).delete_personal_access_token(id) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->delete_personal_access_token: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-personal-access-tokens +List Personal Access Tokens +This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-personal-access-tokens) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | owner_id | **str** | (optional) | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' + Query | filters | **str** | (optional) | 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: **lastUsed**: *le, isnull* + +### Return type +[**List[GetPersonalAccessTokenResponse]**](../models/get-personal-access-token-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of personal access tokens. | List[GetPersonalAccessTokenResponse] | - | +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 | - | +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 + +```python +from sailpoint.v3.api.personal_access_tokens_api import PersonalAccessTokensApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.get_personal_access_token_response import GetPersonalAccessTokenResponse +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + owner_id = '2c9180867b50d088017b554662fb281e' # str | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) # str | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) + filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # 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: **lastUsed**: *le, isnull* (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: **lastUsed**: *le, isnull* (optional) + + try: + # List Personal Access Tokens + + results = PersonalAccessTokensApi(api_client).list_personal_access_tokens() + # Below is a request that includes all optional parameters + # results = PersonalAccessTokensApi(api_client).list_personal_access_tokens(owner_id, filters) + print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->list_personal_access_tokens: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-personal-access-token +Patch Personal Access Token +This performs a targeted update to the field(s) of a Personal Access Token. +Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-personal-access-token) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The Personal Access Token id + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope + +### Return type +[**GetPersonalAccessTokenResponse**](../models/get-personal-access-token-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Indicates the PATCH operation succeeded, and returns the PAT's new representation. | GetPersonalAccessTokenResponse | - | +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-patch+json + - **Accept**: application/json + +### Example + +```python +from sailpoint.v3.api.personal_access_tokens_api import PersonalAccessTokensApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.get_personal_access_token_response import GetPersonalAccessTokenResponse +from sailpoint.v3.models.json_patch_operation import JsonPatchOperation +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Personal Access Token id # str | The Personal Access Token id + json_patch_operation = '''[{op=replace, path=/name, value=New name}, {op=replace, path=/scope, value=[sp:scopes:all]}]''' # List[JsonPatchOperation] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope + + try: + # Patch Personal Access Token + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = PersonalAccessTokensApi(api_client).patch_personal_access_token(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = PersonalAccessTokensApi(api_client).patch_personal_access_token(id, new_json_patch_operation) + print("The response of PersonalAccessTokensApi->patch_personal_access_token:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->patch_personal_access_token: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/PublicIdentitiesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/PublicIdentitiesApi.md new file mode 100644 index 000000000..4cd8c8d05 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/PublicIdentitiesApi.md @@ -0,0 +1,93 @@ +--- +id: public-identities +title: Public_Identities +pagination_label: Public_Identities +sidebar_label: Public_Identities +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Public_Identities', 'Public_Identities'] +slug: /tools/sdk/python/v3/methods/public-identities +tags: ['SDK', 'Software Development Kit', 'Public_Identities', 'Public_Identities'] +--- + +# sailpoint.v3.PublicIdentitiesApi + Use this API in conjunction with [Public Identites Config](https://developer.sailpoint.com/docs/api/v3/public-identities-config/) to enable non-administrators to view identities' publicly visible attributes. +With this functionality in place, non-administrators can view identity attributes other than the default attributes (email, lifecycle state, and manager), depending on which identity attributes their organization administrators have made public. +This can be helpful for access approvers, certification reviewers, managers viewing their direct reports' access, and source owners viewing their tasks. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-public-identities**](#get-public-identities) | **GET** `/public-identities` | Get list of public identities + + +## get-public-identities +Get list of public identities +Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-public-identities) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + 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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* + Query | add_core_filters | **bool** | (optional) (default to False) | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. + Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** + +### Return type +[**List[PublicIdentity]**](../models/public-identity) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | A list of public identity objects. | List[PublicIdentity] | - | +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 | - | +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 + +```python +from sailpoint.v3.api.public_identities_api import PublicIdentitiesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.public_identity import PublicIdentity +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + 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) + filters = 'firstname eq \"John\"' # 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: **id**: *eq, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (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: **id**: *eq, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (optional) + add_core_filters = False # bool | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to False) # bool | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to False) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + try: + # Get list of public identities + + results = PublicIdentitiesApi(api_client).get_public_identities() + # Below is a request that includes all optional parameters + # results = PublicIdentitiesApi(api_client).get_public_identities(limit, offset, count, filters, add_core_filters, sorters) + print("The response of PublicIdentitiesApi->get_public_identities:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PublicIdentitiesApi->get_public_identities: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/PublicIdentitiesConfigApi.md b/docs/tools/sdk/python/Reference/V3/Methods/PublicIdentitiesConfigApi.md new file mode 100644 index 000000000..121952942 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/PublicIdentitiesConfigApi.md @@ -0,0 +1,159 @@ +--- +id: public-identities-config +title: Public_Identities_Config +pagination_label: Public_Identities_Config +sidebar_label: Public_Identities_Config +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Public_Identities_Config', 'Public_Identities_Config'] +slug: /tools/sdk/python/v3/methods/public-identities-config +tags: ['SDK', 'Software Development Kit', 'Public_Identities_Config', 'Public_Identities_Config'] +--- + +# sailpoint.v3.PublicIdentitiesConfigApi + Use this API to implement public identity configuration functionality. +With this functionality in place, administrators can make up to 5 identity attributes publicly visible so other non-administrator users can see the relevant information they need to make decisions. +This can be helpful for approvers making approvals, certification reviewers, managers viewing their direct reports' access, and source owners viewing their tasks. + +By default, non-administrators can select an identity and view the following attributes: email, lifecycle state, and manager. +However, it may be helpful for a non-administrator reviewer to see other identity attributes like department, region, title, etc. +Administrators can use this API to make those necessary identity attributes public to non-administrators. + +For example, a non-administrator deciding whether to approve another identity's request for access to the Workday application, whose access may be restricted to members of the HR department, would want to know whether the identity is a member of the HR department. +If an administrator has used [Update Public Identity Config](https://developer.sailpoint.com/docs/api/v3/update-public-identity-config/) to make the "department" attribute public, the approver can see the department and make a decision without requesting any more information. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-public-identity-config**](#get-public-identity-config) | **GET** `/public-identities-config` | Get the Public Identities Configuration +[**update-public-identity-config**](#update-public-identity-config) | **PUT** `/public-identities-config` | Update the Public Identities Configuration + + +## get-public-identity-config +Get the Public Identities Configuration +Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-public-identity-config) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**PublicIdentityConfig**](../models/public-identity-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Request succeeded. | PublicIdentityConfig | - | +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 | - | +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 + +```python +from sailpoint.v3.api.public_identities_config_api import PublicIdentitiesConfigApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.public_identity_config import PublicIdentityConfig +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + + try: + # Get the Public Identities Configuration + + results = PublicIdentitiesConfigApi(api_client).get_public_identity_config() + # Below is a request that includes all optional parameters + # results = PublicIdentitiesConfigApi(api_client).get_public_identity_config() + print("The response of PublicIdentitiesConfigApi->get_public_identity_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PublicIdentitiesConfigApi->get_public_identity_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-public-identity-config +Update the Public Identities Configuration +Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-public-identity-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | public_identity_config | [**PublicIdentityConfig**](../models/public-identity-config) | True | + +### Return type +[**PublicIdentityConfig**](../models/public-identity-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Request succeeded. | PublicIdentityConfig | - | +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 | - | +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 + +```python +from sailpoint.v3.api.public_identities_config_api import PublicIdentitiesConfigApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.public_identity_config import PublicIdentityConfig +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + public_identity_config = '''{ + "modified" : "2018-06-25T20:22:28.104Z", + "attributes" : [ { + "name" : "Country", + "key" : "country" + }, { + "name" : "Country", + "key" : "country" + } ], + "modifiedBy" : { + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }''' # PublicIdentityConfig | + + try: + # Update the Public Identities Configuration + new_public_identity_config = PublicIdentityConfig.from_json(public_identity_config) + results = PublicIdentitiesConfigApi(api_client).update_public_identity_config(public_identity_config=new_public_identity_config) + # Below is a request that includes all optional parameters + # results = PublicIdentitiesConfigApi(api_client).update_public_identity_config(new_public_identity_config) + print("The response of PublicIdentitiesConfigApi->update_public_identity_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PublicIdentitiesConfigApi->update_public_identity_config: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/ReportsDataExtractionApi.md b/docs/tools/sdk/python/Reference/V3/Methods/ReportsDataExtractionApi.md new file mode 100644 index 000000000..2121f4a48 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/ReportsDataExtractionApi.md @@ -0,0 +1,272 @@ +--- +id: reports-data-extraction +title: Reports_Data_Extraction +pagination_label: Reports_Data_Extraction +sidebar_label: Reports_Data_Extraction +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Reports_Data_Extraction', 'Reports_Data_Extraction'] +slug: /tools/sdk/python/v3/methods/reports-data-extraction +tags: ['SDK', 'Software Development Kit', 'Reports_Data_Extraction', 'Reports_Data_Extraction'] +--- + +# sailpoint.v3.ReportsDataExtractionApi + Use this API to implement reports lifecycle managing and monitoring. +With this functionality in place, users can run reports, view their results, and cancel reports in progress. +This can be potentially helpful for auditing purposes. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**cancel-report**](#cancel-report) | **POST** `/reports/{id}/cancel` | Cancel Report +[**get-report**](#get-report) | **GET** `/reports/{taskResultId}` | Get Report File +[**get-report-result**](#get-report-result) | **GET** `/reports/{taskResultId}/result` | Get Report Result +[**start-report**](#start-report) | **POST** `/reports/run` | Run Report + + +## cancel-report +Cancel Report +Cancels a running report. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/cancel-report) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the running Report to cancel + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +204 | No content - indicates the request was successful but there is no content to be returned in the response. | | - | +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 | - | +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 + +```python +from sailpoint.v3.api.reports_data_extraction_api import ReportsDataExtractionApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'a1ed223247144cc29d23c632624b4767' # str | ID of the running Report to cancel # str | ID of the running Report to cancel + + try: + # Cancel Report + + ReportsDataExtractionApi(api_client).cancel_report(id=id) + # Below is a request that includes all optional parameters + # ReportsDataExtractionApi(api_client).cancel_report(id) + except Exception as e: + print("Exception when calling ReportsDataExtractionApi->cancel_report: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-report +Get Report File +Gets a report in file format. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-report) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | task_result_id | **str** | True | Unique identifier of the task result which handled report + Query | file_format | **str** | True | Output format of the requested report file + Query | name | **str** | (optional) | preferred Report file name, by default will be used report name from task result. + Query | auditable | **bool** | (optional) (default to False) | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. + +### Return type +**bytearray** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Report file in selected format. CSV by default. | bytearray | * Content-disposition - The requested report's filename | +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/csv, application/pdf, application/json + +### Example + +```python +from sailpoint.v3.api.reports_data_extraction_api import ReportsDataExtractionApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + task_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Unique identifier of the task result which handled report # str | Unique identifier of the task result which handled report + file_format = 'csv' # str | Output format of the requested report file # str | Output format of the requested report file + name = 'Identities Details Report' # str | preferred Report file name, by default will be used report name from task result. (optional) # str | preferred Report file name, by default will be used report name from task result. (optional) + auditable = False # bool | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to False) # bool | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to False) + + try: + # Get Report File + + results = ReportsDataExtractionApi(api_client).get_report(task_result_id=task_result_id, file_format=file_format) + # Below is a request that includes all optional parameters + # results = ReportsDataExtractionApi(api_client).get_report(task_result_id, file_format, name, auditable) + print("The response of ReportsDataExtractionApi->get_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ReportsDataExtractionApi->get_report: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-report-result +Get Report Result +Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-report-result) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | task_result_id | **str** | True | Unique identifier of the task result which handled report + Query | completed | **bool** | (optional) (default to False) | state of task result to apply ordering when results are fetching from the DB + +### Return type +[**ReportResults**](../models/report-results) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Details about report that was run or is running. | ReportResults | - | +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 | - | +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 + +```python +from sailpoint.v3.api.reports_data_extraction_api import ReportsDataExtractionApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.report_results import ReportResults +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + task_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Unique identifier of the task result which handled report # str | Unique identifier of the task result which handled report + completed = False # bool | state of task result to apply ordering when results are fetching from the DB (optional) (default to False) # bool | state of task result to apply ordering when results are fetching from the DB (optional) (default to False) + + try: + # Get Report Result + + results = ReportsDataExtractionApi(api_client).get_report_result(task_result_id=task_result_id) + # Below is a request that includes all optional parameters + # results = ReportsDataExtractionApi(api_client).get_report_result(task_result_id, completed) + print("The response of ReportsDataExtractionApi->get_report_result:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ReportsDataExtractionApi->get_report_result: %s\n" % e) +``` + + + +[[Back to top]](#) + +## start-report +Run Report +Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/start-report) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | report_details | [**ReportDetails**](../models/report-details) | True | + +### Return type +[**TaskResultDetails**](../models/task-result-details) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Details about running report task. | TaskResultDetails | - | +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 | - | +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 + +```python +from sailpoint.v3.api.reports_data_extraction_api import ReportsDataExtractionApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.report_details import ReportDetails +from sailpoint.v3.models.task_result_details import TaskResultDetails +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + report_details = '''{ + "reportType" : "ACCOUNTS", + "arguments" : { + "application" : "2c9180897e7742b2017e781782f705b9", + "sourceName" : "Active Directory" + } + }''' # ReportDetails | + + try: + # Run Report + new_report_details = ReportDetails.from_json(report_details) + results = ReportsDataExtractionApi(api_client).start_report(report_details=new_report_details) + # Below is a request that includes all optional parameters + # results = ReportsDataExtractionApi(api_client).start_report(new_report_details) + print("The response of ReportsDataExtractionApi->start_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ReportsDataExtractionApi->start_report: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/RequestableObjectsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/RequestableObjectsApi.md new file mode 100644 index 000000000..397762d93 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/RequestableObjectsApi.md @@ -0,0 +1,102 @@ +--- +id: requestable-objects +title: Requestable_Objects +pagination_label: Requestable_Objects +sidebar_label: Requestable_Objects +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Requestable_Objects', 'Requestable_Objects'] +slug: /tools/sdk/python/v3/methods/requestable-objects +tags: ['SDK', 'Software Development Kit', 'Requestable_Objects', 'Requestable_Objects'] +--- + +# sailpoint.v3.RequestableObjectsApi + Use this API to implement requestable object functionality. +With this functionality in place, administrators can determine which access items can be requested with the [Access Request APIs](https://developer.sailpoint.com/docs/api/v3/access-requests/), along with their statuses. +This can be helpful for administrators who are implementing and customizing access request functionality as a way of checking which items are requestable as they are created, assigned, and made available. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**list-requestable-objects**](#list-requestable-objects) | **GET** `/requestable-objects` | Requestable Objects List + + +## list-requestable-objects +Requestable Objects List +Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v3/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. +Any authenticated token can call this endpoint to see their requestable access items. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-requestable-objects) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | identity_id | **str** | (optional) | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. + Query | types | [**[]RequestableObjectType**](../models/requestable-object-type) | (optional) | Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. + Query | term | **str** | (optional) | Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. + Query | statuses | [**[]RequestableObjectRequestStatus**](../models/requestable-object-request-status) | (optional) | Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + 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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* + Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** + +### Return type +[**List[RequestableObject]**](../models/requestable-object) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of requestable objects | List[RequestableObject] | - | +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 | - | +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 + +```python +from sailpoint.v3.api.requestable_objects_api import RequestableObjectsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.requestable_object import RequestableObject +from sailpoint.v3.models.requestable_object_request_status import RequestableObjectRequestStatus +from sailpoint.v3.models.requestable_object_type import RequestableObjectType +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + identity_id = 'e7eab60924f64aa284175b9fa3309599' # str | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) # str | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) + types = '''[sailpoint.v3.RequestableObjectType()]''' # List[RequestableObjectType] | Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. (optional) + term = 'Finance Role' # str | Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. (optional) # str | Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. (optional) + statuses = '''[sailpoint.v3.RequestableObjectRequestStatus()]''' # List[RequestableObjectRequestStatus] | Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. (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) + filters = 'name sw \"bob\"' # 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: **id**: *eq, in* **name**: *eq, in, sw* (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: **id**: *eq, in* **name**: *eq, in, sw* (optional) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + try: + # Requestable Objects List + + results = RequestableObjectsApi(api_client).list_requestable_objects() + # Below is a request that includes all optional parameters + # results = RequestableObjectsApi(api_client).list_requestable_objects(identity_id, types, term, statuses, limit, offset, count, filters, sorters) + print("The response of RequestableObjectsApi->list_requestable_objects:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/RolesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/RolesApi.md new file mode 100644 index 000000000..b99f995af --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/RolesApi.md @@ -0,0 +1,683 @@ +--- +id: roles +title: Roles +pagination_label: Roles +sidebar_label: Roles +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Roles', 'Roles'] +slug: /tools/sdk/python/v3/methods/roles +tags: ['SDK', 'Software Development Kit', 'Roles', 'Roles'] +--- + +# sailpoint.v3.RolesApi + Use this API to implement and customize role functionality. +With this functionality in place, administrators can create roles and configure them for use throughout Identity Security Cloud. +Identity Security Cloud can use established criteria to automatically assign the roles to qualified users. This enables users to get all the access they need quickly and securely and administrators to spend their time on other tasks. + +Entitlements represent the most granular level of access in Identity Security Cloud. +Access profiles represent the next level and often group entitlements. +Roles represent the broadest level of access and often group access profiles. + +For example, an Active Directory source in Identity Security Cloud can have multiple entitlements: the first, 'Employees,' may represent the access all employees have at the organization, and a second, 'Developers,' may represent the access all developers have at the organization. + +An administrator can then create a broader set of access in the form of an access profile, 'AD Developers' grouping the 'Employees' entitlement with the 'Developers' entitlement. + +An administrator can then create an even broader set of access in the form of a role grouping the 'AD Developers' access profile with another profile, 'GitHub Developers,' grouping entitlements for the GitHub source. + +When users only need Active Directory employee access, they can request access to the 'Employees' entitlement. + +When users need both Active Directory employee and developer access, they can request access to the 'AD Developers' access profile. + +When users need both the 'AD Developers' access profile and the 'GitHub Developers' access profile, they can request access to the role grouping both. + +Roles often represent positions within organizations. +For example, an organization's accountant can access all the tools the organization's accountants need with the 'Accountant' role. +If the accountant switches to engineering, a qualified member of the organization can quickly revoke the accountant's 'Accountant' access and grant access to the 'Engineer' role instead, granting access to all the tools the organization's engineers need. + +In Identity Security Cloud, adminstrators can use the Access drop-down menu and select Roles to view, configure, and delete existing roles, as well as create new ones. +Administrators can enable and disable the role, and they can also make the following configurations: + +- Manage Access: Manage the role's access by adding or removing access profiles. + +- Define Assignment: Define the criteria Identity Security Cloud uses to assign the role to identities. +Use the first option, 'Standard Criteria,' to provide specific criteria for assignment like specific account attributes, entitlements, or identity attributes. +Use the second, 'Identity List,' to specify the identities for assignment. + +- Access Requests: Configure roles to be requestable and establish an approval process for any requests that the role be granted or revoked. +Do not configure a role to be requestable without establishing a secure access request approval process for that role first. + +Refer to [Working with Roles](https://documentation.sailpoint.com/saas/help/access/roles.html) for more information about roles. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-role**](#create-role) | **POST** `/roles` | Create a Role +[**delete-bulk-roles**](#delete-bulk-roles) | **POST** `/roles/bulk-delete` | Delete Role(s) +[**delete-role**](#delete-role) | **DELETE** `/roles/{id}` | Delete a Role +[**get-role**](#get-role) | **GET** `/roles/{id}` | Get a Role +[**get-role-assigned-identities**](#get-role-assigned-identities) | **GET** `/roles/{id}/assigned-identities` | List Identities assigned a Role +[**list-roles**](#list-roles) | **GET** `/roles` | List Roles +[**patch-role**](#patch-role) | **PATCH** `/roles/{id}` | Patch a specified Role + + +## create-role +Create a Role +This API creates a role. +In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. + +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-role) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | role | [**Role**](../models/role) | True | + +### Return type +[**Role**](../models/role) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Role created | Role | - | +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 | - | +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 + +```python +from sailpoint.v3.api.roles_api import RolesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.role import Role +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + role = '''{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "dimensional" : false, + "created" : "2021-03-01T22:32:58.104Z", + "dimensionRefs" : [ { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + }, { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + } ], + "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", + "membership" : { + "identities" : [ { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } ], + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, + "type" : "IDENTITY_LIST" + }, + "enabled" : true, + "revocationRequestConfig" : { + "commentsRequired" : false, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : false + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "legacyMembershipInfo" : { + "type" : "IDENTITY_LIST" + }, + "accessRequestConfig" : { + "commentsRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "name" : "Role 2567", + "modified" : "2021-03-02T20:22:28.104Z", + "accessModelMetadata" : { + "attributes" : [ { + "key" : "iscPrivacy", + "name" : "Privacy", + "multiselect" : false, + "status" : "active", + "type" : "governance", + "objectTypes" : [ "all" ], + "description" : "Specifies the level of privacy associated with an access item.", + "values" : [ { + "value" : "public", + "name" : "Public", + "status" : "active" + } ] + } ] + }, + "id" : "2c918086749d78830174a1a40e121518", + "requestable" : true + }''' # Role | + + try: + # Create a Role + new_role = Role.from_json(role) + results = RolesApi(api_client).create_role(role=new_role) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).create_role(new_role) + print("The response of RolesApi->create_role:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RolesApi->create_role: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-bulk-roles +Delete Role(s) +This endpoint initiates a bulk deletion of one or more roles. +When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. +This endpoint can only bulk delete up to a limit of 50 roles per request. +A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-bulk-roles) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | role_bulk_delete_request | [**RoleBulkDeleteRequest**](../models/role-bulk-delete-request) | True | + +### Return type +[**TaskResultDto**](../models/task-result-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Returns an object with the id of the task performing the delete operation. | TaskResultDto | - | +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 | - | +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 + +```python +from sailpoint.v3.api.roles_api import RolesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.role_bulk_delete_request import RoleBulkDeleteRequest +from sailpoint.v3.models.task_result_dto import TaskResultDto +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + role_bulk_delete_request = '''{ + "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + }''' # RoleBulkDeleteRequest | + + try: + # Delete Role(s) + new_role_bulk_delete_request = RoleBulkDeleteRequest.from_json(role_bulk_delete_request) + results = RolesApi(api_client).delete_bulk_roles(role_bulk_delete_request=new_role_bulk_delete_request) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).delete_bulk_roles(new_role_bulk_delete_request) + print("The response of RolesApi->delete_bulk_roles:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RolesApi->delete_bulk_roles: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-role +Delete a Role +This API deletes a Role by its ID. + +A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-role) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Role + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +204 | No content - indicates the request was successful but there is no content to be returned in the response. | | - | +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 | - | +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 + +```python +from sailpoint.v3.api.roles_api import RolesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role + + try: + # Delete a Role + + RolesApi(api_client).delete_role(id=id) + # Below is a request that includes all optional parameters + # RolesApi(api_client).delete_role(id) + except Exception as e: + print("Exception when calling RolesApi->delete_role: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-role +Get a Role +This API returns a Role by its ID. +A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-role) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Role + +### Return type +[**Role**](../models/role) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of all Roles | Role | - | +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 | - | +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 + +```python +from sailpoint.v3.api.roles_api import RolesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.role import Role +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role + + try: + # Get a Role + + results = RolesApi(api_client).get_role(id=id) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).get_role(id) + print("The response of RolesApi->get_role:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RolesApi->get_role: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-role-assigned-identities +List Identities assigned a Role + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-role-assigned-identities) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Role for which the assigned Identities are to be listed + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + 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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* + Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** + +### Return type +[**List[RoleIdentity]**](../models/role-identity) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of Identities assigned the Role | List[RoleIdentity] | - | +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 | - | +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 + +```python +from sailpoint.v3.api.roles_api import RolesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.role_identity import RoleIdentity +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121e121518' # str | ID of the Role for which the assigned Identities are to be listed # str | ID of the Role for which the assigned Identities are to be listed + 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) + filters = 'name sw Joe' # 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: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (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: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) + sorters = 'aliasName,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) + + try: + # List Identities assigned a Role + + results = RolesApi(api_client).get_role_assigned_identities(id=id) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).get_role_assigned_identities(id, limit, offset, count, filters, sorters) + print("The response of RolesApi->get_role_assigned_identities:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-roles +List Roles +This API returns a list of Roles. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-roles) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | for_subadmin | **str** | (optional) | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. + Query | limit | **int** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* + Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** + Query | for_segment_ids | **str** | (optional) | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. + Query | include_unsegmented | **bool** | (optional) (default to True) | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. + +### Return type +[**List[Role]**](../models/role) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of Roles | List[Role] | - | +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 | - | +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 + +```python +from sailpoint.v3.api.roles_api import RolesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.role import Role +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + for_subadmin = '5168015d32f890ca15812c9180835d2e' # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + 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) + filters = 'requestable eq false' # 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: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (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: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) + sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + include_unsegmented = True # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) + + try: + # List Roles + + results = RolesApi(api_client).list_roles() + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).list_roles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) + print("The response of RolesApi->list_roles:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RolesApi->list_roles: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-role +Patch a specified Role +This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. +The following fields are patchable: +* name +* description +* enabled +* owner +* accessProfiles +* entitlements +* membership +* requestable +* accessRequestConfig +* revokeRequestConfig +* segments +* accessModelMetadata + +A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. + +When you use this API to modify a role's membership identities, you can only modify up to a limit of 500 membership identities at a time. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-role) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the Role to patch + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | + +### Return type +[**Role**](../models/role) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Responds with the Role as updated. | Role | - | +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 | - | +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-patch+json + - **Accept**: application/json + +### Example + +```python +from sailpoint.v3.api.roles_api import RolesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.json_patch_operation import JsonPatchOperation +from sailpoint.v3.models.role import Role +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121e121518' # str | ID of the Role to patch # str | ID of the Role to patch + json_patch_operation = '''[{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}]''' # List[JsonPatchOperation] | + + try: + # Patch a specified Role + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = RolesApi(api_client).patch_role(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).patch_role(id, new_json_patch_operation) + print("The response of RolesApi->patch_role:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RolesApi->patch_role: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/SODPoliciesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/SODPoliciesApi.md new file mode 100644 index 000000000..e464d48c2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/SODPoliciesApi.md @@ -0,0 +1,1224 @@ +--- +id: sod-policies +title: SOD_Policies +pagination_label: SOD_Policies +sidebar_label: SOD_Policies +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SOD_Policies', 'SOD_Policies'] +slug: /tools/sdk/python/v3/methods/sod-policies +tags: ['SDK', 'Software Development Kit', 'SOD_Policies', 'SOD_Policies'] +--- + +# sailpoint.v3.SODPoliciesApi + Use this API to implement and manage "separation of duties" (SOD) policies. +With SOD policy functionality in place, administrators can organize the access in their tenants to prevent individuals from gaining conflicting or excessive access. + +"Separation of duties" refers to the concept that people shouldn't have conflicting sets of access - all their access should be configured in a way that protects your organization's assets and data. +For example, people who record monetary transactions shouldn't be able to issue payment for those transactions. +Any changes to major system configurations should be approved by someone other than the person requesting the change. + +Organizations can use "separation of duties" (SOD) policies to enforce and track their internal security rules throughout their tenants. +These SOD policies limit each user's involvement in important processes and protects the organization from individuals gaining excessive access. + +To create SOD policies in Identity Security Cloud, administrators use 'Search' and then access 'Policies'. +To create a policy, they must configure two lists of access items. Each access item can only be added to one of the two lists. +They can search for the entitlements they want to add to these access lists. + +>Note: You can have a maximum of 500 policies of any type (including general policies) in your organization. In each access-based SOD policy, you can have a maximum of 50 entitlements in each access list. + +Once a SOD policy is in place, if an identity has access items on both lists, a SOD violation will trigger. +These violations are included in SOD violation reports that other users will see in emails at regular intervals if they're subscribed to the SOD policy. +The other users can then better help to enforce these SOD policies. + +To create a subscription to a SOD policy in Identity Security Cloud, administrators use 'Search' and then access 'Layers'. +They can create a subscription to the policy and schedule it to run at a regular interval. + +Refer to [Managing Policies](https://documentation.sailpoint.com/saas/help/sod/manage-policies.html) for more information about SOD policies. + +Refer to [Subscribe to a SOD Policy](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html#subscribe-to-an-sod-policy) for more information about SOD policy subscriptions. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-sod-policy**](#create-sod-policy) | **POST** `/sod-policies` | Create SOD policy +[**delete-sod-policy**](#delete-sod-policy) | **DELETE** `/sod-policies/{id}` | Delete SOD policy by ID +[**delete-sod-policy-schedule**](#delete-sod-policy-schedule) | **DELETE** `/sod-policies/{id}/schedule` | Delete SOD policy schedule +[**get-custom-violation-report**](#get-custom-violation-report) | **GET** `/sod-violation-report/{reportResultId}/download/{fileName}` | Download custom violation report +[**get-default-violation-report**](#get-default-violation-report) | **GET** `/sod-violation-report/{reportResultId}/download` | Download violation report +[**get-sod-all-report-run-status**](#get-sod-all-report-run-status) | **GET** `/sod-violation-report` | Get multi-report run task status +[**get-sod-policy**](#get-sod-policy) | **GET** `/sod-policies/{id}` | Get SOD policy by ID +[**get-sod-policy-schedule**](#get-sod-policy-schedule) | **GET** `/sod-policies/{id}/schedule` | Get SOD policy schedule +[**get-sod-violation-report-run-status**](#get-sod-violation-report-run-status) | **GET** `/sod-policies/sod-violation-report-status/{reportResultId}` | Get violation report run status +[**get-sod-violation-report-status**](#get-sod-violation-report-status) | **GET** `/sod-policies/{id}/violation-report` | Get SOD violation report status +[**list-sod-policies**](#list-sod-policies) | **GET** `/sod-policies` | List SOD policies +[**patch-sod-policy**](#patch-sod-policy) | **PATCH** `/sod-policies/{id}` | Patch SOD policy by ID +[**put-policy-schedule**](#put-policy-schedule) | **PUT** `/sod-policies/{id}/schedule` | Update SOD Policy schedule +[**put-sod-policy**](#put-sod-policy) | **PUT** `/sod-policies/{id}` | Update SOD policy by ID +[**start-evaluate-sod-policy**](#start-evaluate-sod-policy) | **POST** `/sod-policies/{id}/evaluate` | Evaluate one policy by ID +[**start-sod-all-policies-for-org**](#start-sod-all-policies-for-org) | **POST** `/sod-violation-report/run` | Runs all policies for org +[**start-sod-policy**](#start-sod-policy) | **POST** `/sod-policies/{id}/violation-report/run` | Runs SOD policy violation report + + +## create-sod-policy +Create SOD policy +This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-sod-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | sod_policy | [**SodPolicy**](../models/sod-policy) | True | + +### Return type +[**SodPolicy**](../models/sod-policy) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | SOD policy created | SodPolicy | - | +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 | - | +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 + +```python +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.sod_policy import SodPolicy +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + + try: + # Create SOD policy + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) + print("The response of SODPoliciesApi->create_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-sod-policy +Delete SOD policy by ID +This deletes a specified SOD policy. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-sod-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the SOD Policy to delete. + Query | logical | **bool** | (optional) (default to True) | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. + +### 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. | 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 + +```python +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. + logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) + + try: + # Delete SOD policy by ID + + SODPoliciesApi(api_client).delete_sod_policy(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy(id, logical) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-sod-policy-schedule +Delete SOD policy schedule +This deletes schedule for a specified SOD policy by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-sod-policy-schedule) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the SOD policy the schedule must be deleted for. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +204 | No content response. | | - | +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 + +```python +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. + + try: + # Delete SOD policy schedule + + SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-custom-violation-report +Download custom violation report +This allows to download a specified named violation report for a given report reference. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-custom-violation-report) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | report_result_id | **str** | True | The ID of the report reference to download. +Path | file_name | **str** | True | Custom Name for the file. + +### Return type +**bytearray** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns the zip file with given custom name that contains the violation report file. | bytearray | - | +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/zip, application/json + +### Example + +```python +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. + + try: + # Download custom violation report + + results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) + print("The response of SODPoliciesApi->get_custom_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-default-violation-report +Download violation report +This allows to download a violation report for a given report reference. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-default-violation-report) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | report_result_id | **str** | True | The ID of the report reference to download. + +### Return type +**bytearray** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Returns the PolicyReport.zip that contains the violation report file. | bytearray | - | +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/zip, application/json + +### Example + +```python +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + + try: + # Download violation report + + results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) + print("The response of SODPoliciesApi->get_default_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-sod-all-report-run-status +Get multi-report run task status +This endpoint gets the status for a violation report for all policy run. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-sod-all-report-run-status) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**ReportResultReference**](../models/report-result-reference) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Status of the violation report run task for all policy run. | ReportResultReference | - | +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 | - | +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 + +```python +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.report_result_reference import ReportResultReference +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + + try: + # Get multi-report run task status + + results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-sod-policy +Get SOD policy by ID +This gets specified SOD policy. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-sod-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the SOD Policy to retrieve. + +### Return type +[**SodPolicy**](../models/sod-policy) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | SOD policy ID. | SodPolicy | - | +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 + +```python +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.sod_policy import SodPolicy +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. + + try: + # Get SOD policy by ID + + results = SODPoliciesApi(api_client).get_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy(id) + print("The response of SODPoliciesApi->get_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-sod-policy-schedule +Get SOD policy schedule +This endpoint gets a specified SOD policy's schedule. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-sod-policy-schedule) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the SOD policy schedule to retrieve. + +### Return type +[**SodPolicySchedule**](../models/sod-policy-schedule) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | SOD policy schedule. | SodPolicySchedule | - | +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 | - | +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 + +```python +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.sod_policy_schedule import SodPolicySchedule +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. + + try: + # Get SOD policy schedule + + results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) + print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-sod-violation-report-run-status +Get violation report run status +This gets the status for a violation report run task that has already been invoked. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-sod-violation-report-run-status) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | report_result_id | **str** | True | The ID of the report reference to retrieve. + +### Return type +[**ReportResultReference**](../models/report-result-reference) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Status of the violation report run task. | ReportResultReference | - | +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 + +```python +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.report_result_reference import ReportResultReference +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. + + try: + # Get violation report run status + + results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) + print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-sod-violation-report-status +Get SOD violation report status +This gets the status for a violation report run task that has already been invoked. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-sod-violation-report-status) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the violation report to retrieve status for. + +### Return type +[**ReportResultReference**](../models/report-result-reference) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Status of the violation report run task. | ReportResultReference | - | +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 + +```python +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.report_result_reference import ReportResultReference +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. + + try: + # Get SOD violation report status + + results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) + print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-sod-policies +List SOD policies +This gets list of all SOD policies. +Requires role of ORG_ADMIN + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-sod-policies) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + 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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* + Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** + +### Return type +[**List[SodPolicy]**](../models/sod-policy) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of all SOD policies. | List[SodPolicy] | - | +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 | - | +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 + +```python +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.sod_policy import SodPolicy +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + 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) + filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # 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: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (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: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + + try: + # List SOD policies + + results = SODPoliciesApi(api_client).list_sod_policies() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) + print("The response of SODPoliciesApi->list_sod_policies:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-sod-policy +Patch SOD policy by ID +Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +Requires role of ORG_ADMIN. +This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-sod-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the SOD policy being modified. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + +### Return type +[**SodPolicy**](../models/sod-policy) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Indicates the PATCH operation succeeded, and returns the SOD policy's new representation. | SodPolicy | - | +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-patch+json + - **Accept**: application/json + +### Example + +```python +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.json_patch_operation import JsonPatchOperation +from sailpoint.v3.models.sod_policy import SodPolicy +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. + json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + + try: + # Patch SOD policy by ID + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) + print("The response of SODPoliciesApi->patch_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-policy-schedule +Update SOD Policy schedule +This updates schedule for a specified SOD policy. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-policy-schedule) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the SOD policy to update its schedule. + Body | sod_policy_schedule | [**SodPolicySchedule**](../models/sod-policy-schedule) | True | + +### Return type +[**SodPolicySchedule**](../models/sod-policy-schedule) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Created or updated SOD policy schedule. | SodPolicySchedule | - | +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 | - | +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 + +```python +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.sod_policy_schedule import SodPolicySchedule +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. + sod_policy_schedule = '''{ + "schedule" : { + "hours" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "months" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + }''' # SodPolicySchedule | + + try: + # Update SOD Policy schedule + new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) + results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) + print("The response of SODPoliciesApi->put_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-sod-policy +Update SOD policy by ID +This updates a specified SOD policy. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-sod-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The ID of the SOD policy to update. + Body | sod_policy | [**SodPolicy**](../models/sod-policy) | True | + +### Return type +[**SodPolicy**](../models/sod-policy) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | SOD Policy by ID | SodPolicy | - | +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 + +```python +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.sod_policy import SodPolicy +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + + try: + # Update SOD policy by ID + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) + print("The response of SODPoliciesApi->put_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) +``` + + + +[[Back to top]](#) + +## start-evaluate-sod-policy +Evaluate one policy by ID +Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/start-evaluate-sod-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The SOD policy ID to run. + +### Return type +[**ReportResultReference**](../models/report-result-reference) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Reference to the violation report run task. | ReportResultReference | - | +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 | - | +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 + +```python +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.report_result_reference import ReportResultReference +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + + try: + # Evaluate one policy by ID + + results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) + print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) +``` + + + +[[Back to top]](#) + +## start-sod-all-policies-for-org +Runs all policies for org +Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/start-sod-all-policies-for-org) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | multi_policy_request | [**MultiPolicyRequest**](../models/multi-policy-request) | (optional) | + +### Return type +[**ReportResultReference**](../models/report-result-reference) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Reference to the violation report run task. | ReportResultReference | - | +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 | - | +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 + +```python +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.multi_policy_request import MultiPolicyRequest +from sailpoint.v3.models.report_result_reference import ReportResultReference +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + multi_policy_request = '''{ + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + }''' # MultiPolicyRequest | (optional) + + try: + # Runs all policies for org + + results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) + print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) +``` + + + +[[Back to top]](#) + +## start-sod-policy +Runs SOD policy violation report +This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/start-sod-policy) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The SOD policy ID to run. + +### Return type +[**ReportResultReference**](../models/report-result-reference) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Reference to the violation report run task. | ReportResultReference | - | +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 + +```python +from sailpoint.v3.api.sod_policies_api import SODPoliciesApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.report_result_reference import ReportResultReference +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + + try: + # Runs SOD policy violation report + + results = SODPoliciesApi(api_client).start_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_policy(id) + print("The response of SODPoliciesApi->start_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/SODViolationsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/SODViolationsApi.md new file mode 100644 index 000000000..fc997eec3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/SODViolationsApi.md @@ -0,0 +1,172 @@ +--- +id: sod-violations +title: SOD_Violations +pagination_label: SOD_Violations +sidebar_label: SOD_Violations +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SOD_Violations', 'SOD_Violations'] +slug: /tools/sdk/python/v3/methods/sod-violations +tags: ['SDK', 'Software Development Kit', 'SOD_Violations', 'SOD_Violations'] +--- + +# sailpoint.v3.SODViolationsApi + Use this API to check for current "separation of duties" (SOD) policy violations as well as potential future SOD policy violations. +With SOD violation functionality in place, administrators can get information about current SOD policy violations and predict whether an access change will trigger new violations, which helps to prevent them from occurring at all. + +"Separation of duties" refers to the concept that people shouldn't have conflicting sets of access - all their access should be configured in a way that protects your organization's assets and data. +For example, people who record monetary transactions shouldn't be able to issue payment for those transactions. +Any changes to major system configurations should be approved by someone other than the person requesting the change. + +Organizations can use "separation of duties" (SOD) policies to enforce and track their internal security rules throughout their tenants. +These SOD policies limit each user's involvement in important processes and protects the organization from individuals gaining excessive access. + +Once a SOD policy is in place, if an identity has conflicting access items, a SOD violation will trigger. +These violations are included in SOD violation reports that other users will see in emails at regular intervals if they're subscribed to the SOD policy. +The other users can then better help to enforce these SOD policies. + +Administrators can use the SOD violations APIs to check a set of identities for any current SOD violations, and they can use them to check whether adding an access item would potentially trigger a SOD violation. +This second option is a good way to prevent SOD violations from triggering at all. + +Refer to [Handling Policy Violations](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html) for more information about SOD policy violations. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**start-predict-sod-violations**](#start-predict-sod-violations) | **POST** `/sod-violations/predict` | Predict SOD violations for identity. +[**start-violation-check**](#start-violation-check) | **POST** `/sod-violations/check` | Check SOD violations + + +## start-predict-sod-violations +Predict SOD violations for identity. +This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/start-predict-sod-violations) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | identity_with_new_access | [**IdentityWithNewAccess**](../models/identity-with-new-access) | True | + +### Return type +[**ViolationPrediction**](../models/violation-prediction) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Violation Contexts | ViolationPrediction | - | +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 + +```python +from sailpoint.v3.api.sod_violations_api import SODViolationsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.identity_with_new_access import IdentityWithNewAccess +from sailpoint.v3.models.violation_prediction import ViolationPrediction +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + identity_with_new_access = '''{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + }''' # IdentityWithNewAccess | + + try: + # Predict SOD violations for identity. + new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) + results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) + print("The response of SODViolationsApi->start_predict_sod_violations:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) +``` + + + +[[Back to top]](#) + +## start-violation-check +Check SOD violations +This API initiates a SOD policy verification asynchronously. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/start-violation-check) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | identity_with_new_access1 | [**IdentityWithNewAccess1**](../models/identity-with-new-access1) | True | + +### Return type +[**SodViolationCheck**](../models/sod-violation-check) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Request ID with a timestamp. | SodViolationCheck | - | +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 + +```python +from sailpoint.v3.api.sod_violations_api import SODViolationsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.identity_with_new_access1 import IdentityWithNewAccess1 +from sailpoint.v3.models.sod_violation_check import SodViolationCheck +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | + + try: + # Check SOD violations + new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) + results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) + print("The response of SODViolationsApi->start_violation_check:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/SavedSearchApi.md b/docs/tools/sdk/python/Reference/V3/Methods/SavedSearchApi.md new file mode 100644 index 000000000..23fb26d5b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/SavedSearchApi.md @@ -0,0 +1,456 @@ +--- +id: saved-search +title: Saved_Search +pagination_label: Saved_Search +sidebar_label: Saved_Search +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Saved_Search', 'Saved_Search'] +slug: /tools/sdk/python/v3/methods/saved-search +tags: ['SDK', 'Software Development Kit', 'Saved_Search', 'Saved_Search'] +--- + +# sailpoint.v3.SavedSearchApi + Use this API to implement saved search functionality. +With saved search functionality in place, users can save search queries and then view those saved searches, as well as rerun them. + +Search queries in Identity Security Cloud can grow very long and specific, which can make reconstructing them difficult or tedious, so it can be especially helpful to save search queries. +It also opens the possibility to configure Identity Security Cloud to run the saved queries on a schedule, which is essential to detecting user information and access changes throughout an organization's tenant and across all its sources. +Refer to [Scheduled Search](https://developer.sailpoint.com/docs/api/v3/scheduled-search/) for more information about running saved searches on a schedule. + +In Identity Security Cloud, users can save searches under a name, and then they can access that saved search and run it again when they want. + +Refer to [Managing Saved Searches](https://documentation.sailpoint.com/saas/help/search/saved-searches.html) for more information about saving searches and using them. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-saved-search**](#create-saved-search) | **POST** `/saved-searches` | Create a saved search +[**delete-saved-search**](#delete-saved-search) | **DELETE** `/saved-searches/{id}` | Delete document by ID +[**execute-saved-search**](#execute-saved-search) | **POST** `/saved-searches/{id}/execute` | Execute a saved search by ID +[**get-saved-search**](#get-saved-search) | **GET** `/saved-searches/{id}` | Return saved search by ID +[**list-saved-searches**](#list-saved-searches) | **GET** `/saved-searches` | A list of Saved Searches +[**put-saved-search**](#put-saved-search) | **PUT** `/saved-searches/{id}` | Updates an existing saved search + + +## create-saved-search +Create a saved search +Creates a new saved search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-saved-search) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | create_saved_search_request | [**CreateSavedSearchRequest**](../models/create-saved-search-request) | True | The saved search to persist. + +### Return type +[**SavedSearch**](../models/saved-search) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | The persisted saved search. | SavedSearch | - | +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 | - | +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 + +```python +from sailpoint.v3.api.saved_search_api import SavedSearchApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.create_saved_search_request import CreateSavedSearchRequest +from sailpoint.v3.models.saved_search import SavedSearch +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + create_saved_search_request = '''sailpoint.v3.CreateSavedSearchRequest()''' # CreateSavedSearchRequest | The saved search to persist. + + try: + # Create a saved search + new_create_saved_search_request = CreateSavedSearchRequest.from_json(create_saved_search_request) + results = SavedSearchApi(api_client).create_saved_search(create_saved_search_request=new_create_saved_search_request) + # Below is a request that includes all optional parameters + # results = SavedSearchApi(api_client).create_saved_search(new_create_saved_search_request) + print("The response of SavedSearchApi->create_saved_search:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SavedSearchApi->create_saved_search: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-saved-search +Delete document by ID +Deletes the specified saved search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-saved-search) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the requested document. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +204 | No Content - Indicates the request was successful but there is no content to be returned in the response. | | - | +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 + +```python +from sailpoint.v3.api.saved_search_api import SavedSearchApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + + try: + # Delete document by ID + + SavedSearchApi(api_client).delete_saved_search(id=id) + # Below is a request that includes all optional parameters + # SavedSearchApi(api_client).delete_saved_search(id) + except Exception as e: + print("Exception when calling SavedSearchApi->delete_saved_search: %s\n" % e) +``` + + + +[[Back to top]](#) + +## execute-saved-search +Execute a saved search by ID +Executes the specified saved search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/execute-saved-search) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the requested document. + Body | search_arguments | [**SearchArguments**](../models/search-arguments) | True | When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Accepted - Returned if the request was successfully accepted into the system. | | - | +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - | +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 | - | +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 + +```python +from sailpoint.v3.api.saved_search_api import SavedSearchApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.search_arguments import SearchArguments +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + search_arguments = '''{ + "owner" : "", + "recipients" : [ { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" + }''' # SearchArguments | When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. + + try: + # Execute a saved search by ID + new_search_arguments = SearchArguments.from_json(search_arguments) + SavedSearchApi(api_client).execute_saved_search(id=id, search_arguments=new_search_arguments) + # Below is a request that includes all optional parameters + # SavedSearchApi(api_client).execute_saved_search(id, new_search_arguments) + except Exception as e: + print("Exception when calling SavedSearchApi->execute_saved_search: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-saved-search +Return saved search by ID +Returns the specified saved search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-saved-search) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the requested document. + +### Return type +[**SavedSearch**](../models/saved-search) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The requested saved search. | SavedSearch | - | +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 + +```python +from sailpoint.v3.api.saved_search_api import SavedSearchApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.saved_search import SavedSearch +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + + try: + # Return saved search by ID + + results = SavedSearchApi(api_client).get_saved_search(id=id) + # Below is a request that includes all optional parameters + # results = SavedSearchApi(api_client).get_saved_search(id) + print("The response of SavedSearchApi->get_saved_search:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SavedSearchApi->get_saved_search: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-saved-searches +A list of Saved Searches +Returns a list of saved searches. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-saved-searches) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | filters | **str** | (optional) | 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: **owner.id**: *eq* + +### Return type +[**List[SavedSearch]**](../models/saved-search) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The list of requested saved searches. | List[SavedSearch] | * X-Total-Count - The total result count (returned only if the *count* parameter is specified as *true*). | +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 | - | +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 + +```python +from sailpoint.v3.api.saved_search_api import SavedSearchApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.saved_search import SavedSearch +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + 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) + 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) + 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) + filters = 'owner.id eq \"7a724640-0c17-4ce9-a8c3-4a89738459c8\"' # 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: **owner.id**: *eq* (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: **owner.id**: *eq* (optional) + + try: + # A list of Saved Searches + + results = SavedSearchApi(api_client).list_saved_searches() + # Below is a request that includes all optional parameters + # results = SavedSearchApi(api_client).list_saved_searches(offset, limit, count, filters) + print("The response of SavedSearchApi->list_saved_searches:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SavedSearchApi->list_saved_searches: %s\n" % e) +``` + + + +[[Back to top]](#) + +## put-saved-search +Updates an existing saved search +Updates an existing saved search. + +>**NOTE: You cannot update the `owner` of the saved search.** + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-saved-search) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the requested document. + Body | saved_search | [**SavedSearch**](../models/saved-search) | True | The saved search to persist. + +### Return type +[**SavedSearch**](../models/saved-search) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The persisted saved search. | SavedSearch | - | +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 | - | +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 + +```python +from sailpoint.v3.api.saved_search_api import SavedSearchApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.saved_search import SavedSearch +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + saved_search = '''{ + "owner" : { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2018-06-25T20:22:28.104Z", + "columns" : { + "identity" : [ { + "field" : "displayName", + "header" : "Display Name" + }, { + "field" : "e-mail", + "header" : "Work Email" + } ] + }, + "query" : "@accounts(disabled:true)", + "description" : "Disabled accounts", + "orderBy" : { + "identity" : [ "lastName", "firstName" ], + "role" : [ "name" ] + }, + "sort" : [ "displayName" ], + "filters" : { + "terms" : [ "account_count", "account_count" ], + "range" : { + "lower" : { + "inclusive" : false, + "value" : "1" + }, + "upper" : { + "inclusive" : false, + "value" : "1" + } + }, + "exclude" : false, + "type" : "RANGE" + }, + "ownerId" : "2c91808568c529c60168cca6f90c1313", + "indices" : [ "identities" ], + "public" : false, + "name" : "Disabled accounts", + "modified" : "2018-06-25T20:22:28.104Z", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "fields" : [ "disabled" ] + }''' # SavedSearch | The saved search to persist. + + try: + # Updates an existing saved search + new_saved_search = SavedSearch.from_json(saved_search) + results = SavedSearchApi(api_client).put_saved_search(id=id, saved_search=new_saved_search) + # Below is a request that includes all optional parameters + # results = SavedSearchApi(api_client).put_saved_search(id, new_saved_search) + print("The response of SavedSearchApi->put_saved_search:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SavedSearchApi->put_saved_search: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/ScheduledSearchApi.md b/docs/tools/sdk/python/Reference/V3/Methods/ScheduledSearchApi.md new file mode 100644 index 000000000..7ed54200a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/ScheduledSearchApi.md @@ -0,0 +1,460 @@ +--- +id: scheduled-search +title: Scheduled_Search +pagination_label: Scheduled_Search +sidebar_label: Scheduled_Search +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Scheduled_Search', 'Scheduled_Search'] +slug: /tools/sdk/python/v3/methods/scheduled-search +tags: ['SDK', 'Software Development Kit', 'Scheduled_Search', 'Scheduled_Search'] +--- + +# sailpoint.v3.ScheduledSearchApi + Use this API to implement scheduled search functionality. +With scheduled search functionality in place, users can run saved search queries on their tenants on a schedule, and Identity Security Cloud emails them the search results. +Users can also share these search results with other users by email by adding those users as subscribers, or those users can subscribe themselves. + +One of the greatest benefits of saving searches is the ability to run those searches on a schedule. +This is essential for organizations to constantly detect any changes to user information or access throughout their tenants and across all their sources. +For example, the manager Amanda Ross can schedule a saved search "manager.name:amanda.ross AND attributes.location:austin" on a schedule to regularly stay aware of changes with the Austin employees reporting to her. +Identity Security Cloud emails her the search results when the search runs, so she can work on other tasks instead of actively running this search. + +In Identity Security Cloud, scheduling a search involves a subscription. +Users can create a subscription for a saved search and schedule it to run daily, weekly, or monthly (you can only use one schedule option at a time). +The user can add other identities as subscribers so when the scheduled search runs, the subscribers and the user all receive emails. + +By default, subscriptions exclude detailed results from the emails, for security purposes. +Including detailed results about user access in an email may expose sensitive information. +However, the subscription creator can choose to include the information in the emails. + +By default, Identity Security Cloud sends emails to the subscribers even when the searches do not return new results. +However, the subscription creator can choose to suppress these empty emails. + +Users can also subscribe to saved searches that already have existing subscriptions so they receive emails when the searches run. +A saved search can have up to 10 subscriptions configured at a time. + +The subscription creator can enable, disable, or delete the subscription. + +Refer to [Subscribing to Saved Searches](https://documentation.sailpoint.com/saas/help/search/saved-searches.html#subscribing-to-saved-searches) for more information about scheduling searches and subscribing to them. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-scheduled-search**](#create-scheduled-search) | **POST** `/scheduled-searches` | Create a new scheduled search +[**delete-scheduled-search**](#delete-scheduled-search) | **DELETE** `/scheduled-searches/{id}` | Delete a Scheduled Search +[**get-scheduled-search**](#get-scheduled-search) | **GET** `/scheduled-searches/{id}` | Get a Scheduled Search +[**list-scheduled-search**](#list-scheduled-search) | **GET** `/scheduled-searches` | List scheduled searches +[**unsubscribe-scheduled-search**](#unsubscribe-scheduled-search) | **POST** `/scheduled-searches/{id}/unsubscribe` | Unsubscribe a recipient from Scheduled Search +[**update-scheduled-search**](#update-scheduled-search) | **PUT** `/scheduled-searches/{id}` | Update an existing Scheduled Search + + +## create-scheduled-search +Create a new scheduled search +Creates a new scheduled search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-scheduled-search) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | create_scheduled_search_request | [**CreateScheduledSearchRequest**](../models/create-scheduled-search-request) | True | The scheduled search to persist. + +### Return type +[**ScheduledSearch**](../models/scheduled-search) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | The persisted scheduled search. | ScheduledSearch | - | +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 + +```python +from sailpoint.v3.api.scheduled_search_api import ScheduledSearchApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.create_scheduled_search_request import CreateScheduledSearchRequest +from sailpoint.v3.models.scheduled_search import ScheduledSearch +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + create_scheduled_search_request = '''{savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]}''' # CreateScheduledSearchRequest | The scheduled search to persist. + + try: + # Create a new scheduled search + new_create_scheduled_search_request = CreateScheduledSearchRequest.from_json(create_scheduled_search_request) + results = ScheduledSearchApi(api_client).create_scheduled_search(create_scheduled_search_request=new_create_scheduled_search_request) + # Below is a request that includes all optional parameters + # results = ScheduledSearchApi(api_client).create_scheduled_search(new_create_scheduled_search_request) + print("The response of ScheduledSearchApi->create_scheduled_search:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ScheduledSearchApi->create_scheduled_search: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-scheduled-search +Delete a Scheduled Search +Deletes the specified scheduled search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-scheduled-search) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the requested document. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +204 | No Content - Indicates the request was successful but there is no content to be returned in the response. | | - | +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 + +```python +from sailpoint.v3.api.scheduled_search_api import ScheduledSearchApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + + try: + # Delete a Scheduled Search + + ScheduledSearchApi(api_client).delete_scheduled_search(id=id) + # Below is a request that includes all optional parameters + # ScheduledSearchApi(api_client).delete_scheduled_search(id) + except Exception as e: + print("Exception when calling ScheduledSearchApi->delete_scheduled_search: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-scheduled-search +Get a Scheduled Search +Returns the specified scheduled search. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-scheduled-search) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the requested document. + +### Return type +[**ScheduledSearch**](../models/scheduled-search) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The requested scheduled search. | ScheduledSearch | - | +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 + +```python +from sailpoint.v3.api.scheduled_search_api import ScheduledSearchApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.scheduled_search import ScheduledSearch +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + + try: + # Get a Scheduled Search + + results = ScheduledSearchApi(api_client).get_scheduled_search(id=id) + # Below is a request that includes all optional parameters + # results = ScheduledSearchApi(api_client).get_scheduled_search(id) + print("The response of ScheduledSearchApi->get_scheduled_search:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ScheduledSearchApi->get_scheduled_search: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-scheduled-search +List scheduled searches +Returns a list of scheduled searches. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-scheduled-search) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | filters | **str** | (optional) | 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: **owner.id**: *eq* **savedSearchId**: *eq* + +### Return type +[**List[ScheduledSearch]**](../models/scheduled-search) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The list of requested scheduled searches. | List[ScheduledSearch] | * X-Total-Count - The total result count (returned only if the *count* parameter is specified as *true*). | +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 + +```python +from sailpoint.v3.api.scheduled_search_api import ScheduledSearchApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.scheduled_search import ScheduledSearch +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + 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) + 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) + 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) + filters = 'savedSearchId eq \"6cc0945d-9eeb-4948-9033-72d066e1153e\"' # 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: **owner.id**: *eq* **savedSearchId**: *eq* (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: **owner.id**: *eq* **savedSearchId**: *eq* (optional) + + try: + # List scheduled searches + + results = ScheduledSearchApi(api_client).list_scheduled_search() + # Below is a request that includes all optional parameters + # results = ScheduledSearchApi(api_client).list_scheduled_search(offset, limit, count, filters) + print("The response of ScheduledSearchApi->list_scheduled_search:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ScheduledSearchApi->list_scheduled_search: %s\n" % e) +``` + + + +[[Back to top]](#) + +## unsubscribe-scheduled-search +Unsubscribe a recipient from Scheduled Search +Unsubscribes a recipient from the specified scheduled search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/unsubscribe-scheduled-search) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the requested document. + Body | typed_reference | [**TypedReference**](../models/typed-reference) | True | The recipient to be removed from the scheduled search. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +204 | No Content - Indicates the request was successful but there is no content to be returned in the response. | | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +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 | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +from sailpoint.v3.api.scheduled_search_api import ScheduledSearchApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.typed_reference import TypedReference +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + typed_reference = '''{ + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }''' # TypedReference | The recipient to be removed from the scheduled search. + + try: + # Unsubscribe a recipient from Scheduled Search + new_typed_reference = TypedReference.from_json(typed_reference) + ScheduledSearchApi(api_client).unsubscribe_scheduled_search(id=id, typed_reference=new_typed_reference) + # Below is a request that includes all optional parameters + # ScheduledSearchApi(api_client).unsubscribe_scheduled_search(id, new_typed_reference) + except Exception as e: + print("Exception when calling ScheduledSearchApi->unsubscribe_scheduled_search: %s\n" % e) +``` + + + +[[Back to top]](#) + +## update-scheduled-search +Update an existing Scheduled Search +Updates an existing scheduled search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-scheduled-search) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | ID of the requested document. + Body | scheduled_search | [**ScheduledSearch**](../models/scheduled-search) | True | The scheduled search to persist. + +### Return type +[**ScheduledSearch**](../models/scheduled-search) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The persisted scheduled search. | ScheduledSearch | - | +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 + +```python +from sailpoint.v3.api.scheduled_search_api import ScheduledSearchApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.scheduled_search import ScheduledSearch +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + scheduled_search = '''{ + "owner" : { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "displayQueryDetails" : false, + "created" : "", + "description" : "Daily disabled accounts", + "ownerId" : "2c9180867624cbd7017642d8c8c81f67", + "enabled" : false, + "schedule" : { + "hours" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "months" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "recipients" : [ { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + } ], + "savedSearchId" : "554f1511-f0a1-4744-ab14-599514d3e57c", + "name" : "Daily disabled accounts", + "modified" : "", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "emailEmptyResults" : false + }''' # ScheduledSearch | The scheduled search to persist. + + try: + # Update an existing Scheduled Search + new_scheduled_search = ScheduledSearch.from_json(scheduled_search) + results = ScheduledSearchApi(api_client).update_scheduled_search(id=id, scheduled_search=new_scheduled_search) + # Below is a request that includes all optional parameters + # results = ScheduledSearchApi(api_client).update_scheduled_search(id, new_scheduled_search) + print("The response of ScheduledSearchApi->update_scheduled_search:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ScheduledSearchApi->update_scheduled_search: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/SearchApi.md b/docs/tools/sdk/python/Reference/V3/Methods/SearchApi.md new file mode 100644 index 000000000..6cd2d1f71 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/SearchApi.md @@ -0,0 +1,641 @@ +--- +id: search +title: Search +pagination_label: Search +sidebar_label: Search +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Search', 'Search'] +slug: /tools/sdk/python/v3/methods/search +tags: ['SDK', 'Software Development Kit', 'Search', 'Search'] +--- + +# sailpoint.v3.SearchApi + Use this API to implement search functionality. +With search functionality in place, users can search their tenants for nearly any information from throughout their organizations. + +Identity Security Cloud enables organizations to store user data from across all their connected sources and manage the users' access, so the ability to query and filter that data is essential. +Its search goes through all those sources and finds the results quickly and specifically. + +The search query is flexible - it can be very broad or very narrow. +The search only returns results for searchable objects it is filtering for. +The following objects are searchable: identities, roles, access profiles, entitlements, events, and account activities. +By default, no filter is applied, so a search for "Ad" returns both the identity "Adam.Archer" as well as the role "Administrator." + +Users can further narrow their results by using Identity Security Cloud's specific syntax and punctuation to structure their queries. +For example, the query "attributes.location:austin AND NOT manager.name:amanda.ross" returns all results associated with the Austin location, but it excludes those associated with the manager Amanda Ross. +Refer to [Building a Search Query](https://documentation.sailpoint.com/saas/help/search/building-query.html) for more information about how to construct specific search queries. + +Refer to [Using Search](https://documentation.sailpoint.com/saas/help/search/index.html) for more information about Identity Security Cloud's search and its different possibilities. + +The search feature uses Elasticsearch as a datastore and query engine. +The power of Elasticsearch makes this feature suitable for ad-hoc reporting. +However, data from the operational databases (ex. identities, roles, events, etc) has to be ingested into Elasticsearch. +This ingestion process introduces a latency from when the operational data is created to when it is available in search. +Depending on the system load, this can take a few seconds to a few minutes. +Please keep this latency in mind when you use search. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**search-aggregate**](#search-aggregate) | **POST** `/search/aggregate` | Perform a Search Query Aggregation +[**search-count**](#search-count) | **POST** `/search/count` | Count Documents Satisfying a Query +[**search-get**](#search-get) | **GET** `/search/{index}/{id}` | Get a Document by ID +[**search-post**](#search-post) | **POST** `/search` | Perform Search + + +## search-aggregate +Perform a Search Query Aggregation +Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/search-aggregate) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | search | [**Search**](../models/search) | True | + 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**AggregationResult**](../models/aggregation-result) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Aggregation results. | AggregationResult | * X-Total-Count - The total result count (returned only if the *count* parameter is specified as *true*). | +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 | - | +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, text/csv + +### Example + +```python +from sailpoint.v3.api.search_api import SearchApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.aggregation_result import AggregationResult +from sailpoint.v3.models.search import Search +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + search = '''{ + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + }''' # Search | + 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) + 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) + 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: + # Perform a Search Query Aggregation + new_search = Search.from_json(search) + results = SearchApi(api_client).search_aggregate(search=new_search) + # Below is a request that includes all optional parameters + # results = SearchApi(api_client).search_aggregate(new_search, offset, limit, count) + print("The response of SearchApi->search_aggregate:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchApi->search_aggregate: %s\n" % e) +``` + + + +[[Back to top]](#) + +## search-count +Count Documents Satisfying a Query +Performs a search with a provided query and returns the count of results in the X-Total-Count header. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/search-count) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | search | [**Search**](../models/search) | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +204 | No content - indicates the request was successful but there is no content to be returned in the response. | | * X-Total-Count - The total result count (returned only if the *count* parameter is specified as *true*). | +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 | - | +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 + +```python +from sailpoint.v3.api.search_api import SearchApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.search import Search +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + search = '''{ + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + }''' # Search | + + try: + # Count Documents Satisfying a Query + new_search = Search.from_json(search) + SearchApi(api_client).search_count(search=new_search) + # Below is a request that includes all optional parameters + # SearchApi(api_client).search_count(new_search) + except Exception as e: + print("Exception when calling SearchApi->search_count: %s\n" % e) +``` + + + +[[Back to top]](#) + +## search-get +Get a Document by ID +Fetches a single document from the specified index, using the specified document ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/search-get) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | index | **str** | True | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. +Path | id | **str** | True | ID of the requested document. + +### Return type +**object** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The requested document. | object | - | +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 + +```python +from sailpoint.v3.api.search_api import SearchApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + index = 'identities' # str | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. # str | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + + try: + # Get a Document by ID + + results = SearchApi(api_client).search_get(index=index, id=id) + # Below is a request that includes all optional parameters + # results = SearchApi(api_client).search_get(index, id) + print("The response of SearchApi->search_get:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchApi->search_get: %s\n" % e) +``` + + + +[[Back to top]](#) + +## search-post +Perform Search +Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/search-post) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | search | [**Search**](../models/search) | True | + 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +**List[object]** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of matching documents. | List[object] | * X-Total-Count - The total result count (returned only if the *count* parameter is specified as *true*). | +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 | - | +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 + +```python +from sailpoint.v3.api.search_api import SearchApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.search import Search +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + search = '''{ + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + }''' # Search | + 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) + 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) + 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: + # Perform Search + new_search = Search.from_json(search) + results = SearchApi(api_client).search_post(search=new_search) + # Below is a request that includes all optional parameters + # results = SearchApi(api_client).search_post(new_search, offset, limit, count) + print("The response of SearchApi->search_post:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchApi->search_post: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/SearchAttributeConfigurationApi.md b/docs/tools/sdk/python/Reference/V3/Methods/SearchAttributeConfigurationApi.md new file mode 100644 index 000000000..56324446a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/SearchAttributeConfigurationApi.md @@ -0,0 +1,351 @@ +--- +id: search-attribute-configuration +title: Search_Attribute_Configuration +pagination_label: Search_Attribute_Configuration +sidebar_label: Search_Attribute_Configuration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Search_Attribute_Configuration', 'Search_Attribute_Configuration'] +slug: /tools/sdk/python/v3/methods/search-attribute-configuration +tags: ['SDK', 'Software Development Kit', 'Search_Attribute_Configuration', 'Search_Attribute_Configuration'] +--- + +# sailpoint.v3.SearchAttributeConfigurationApi + Use this API to implement search attribute configuration functionality, along with [Search](https://developer.sailpoint.com/docs/api/v3/search). +With this functionality in place, administrators can create custom search attributes that and run extended searches based on those attributes to further narrow down their searches and get the information and insights they want. + +Identity Security Cloud (ISC) enables organizations to store user data from across all their connected sources and manage the users' access, so the ability to query and filter that data is essential. +Its search goes through all those sources and finds the results quickly and specifically. + +The search query is flexible - it can be very broad or very narrow. +The search only returns results for searchable objects it is filtering for. +The following objects are searchable: identities, roles, access profiles, entitlements, events, and account activities. +By default, no filter is applied, so a search for "Ad" returns both the identity "Adam.Archer" as well as the role "Administrator." + +Users can further narrow their results by using ISC's specific syntax and punctuation to structure their queries. +For example, the query "attributes.location:austin AND NOT manager.name:amanda.ross" returns all results associated with the Austin location, but it excludes those associated with the manager Amanda Ross. +Refer to [Building a Search Query](https://documentation.sailpoint.com/saas/help/search/building-query.html) for more information about how to construct specific search queries. + +Refer to [Using Search](https://documentation.sailpoint.com/saas/help/search/index.html) for more information about ISC's search and its different possibilities. + +With Search Attribute Configuration, administrators can create, manage, and run searches based on the attributes they want to search. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-search-attribute-config**](#create-search-attribute-config) | **POST** `/accounts/search-attribute-config` | Create Extended Search Attributes +[**delete-search-attribute-config**](#delete-search-attribute-config) | **DELETE** `/accounts/search-attribute-config/{name}` | Delete Extended Search Attribute +[**get-search-attribute-config**](#get-search-attribute-config) | **GET** `/accounts/search-attribute-config` | List Extended Search Attributes +[**get-single-search-attribute-config**](#get-single-search-attribute-config) | **GET** `/accounts/search-attribute-config/{name}` | Get Extended Search Attribute +[**patch-search-attribute-config**](#patch-search-attribute-config) | **PATCH** `/accounts/search-attribute-config/{name}` | Update Extended Search Attribute + + +## create-search-attribute-config +Create Extended Search Attributes +Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. +>**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes' `applicationAttributes`.** + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-search-attribute-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | search_attribute_config | [**SearchAttributeConfig**](../models/search-attribute-config) | True | + +### Return type +**object** + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +202 | Accepted - Returned if the request was successfully accepted into the system. | object | - | +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 + +```python +from sailpoint.v3.api.search_attribute_configuration_api import SearchAttributeConfigurationApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.search_attribute_config import SearchAttributeConfig +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + search_attribute_config = '''{ + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + }''' # SearchAttributeConfig | + + try: + # Create Extended Search Attributes + new_search_attribute_config = SearchAttributeConfig.from_json(search_attribute_config) + results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(search_attribute_config=new_search_attribute_config) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(new_search_attribute_config) + print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->create_search_attribute_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-search-attribute-config +Delete Extended Search Attribute +Delete an extended attribute configuration by name. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-search-attribute-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | name | **str** | True | Name of the extended search attribute configuration to delete. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +204 | No content - indicates the request was successful but there is no content to be returned in the response. | | - | +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 + +```python +from sailpoint.v3.api.search_attribute_configuration_api import SearchAttributeConfigurationApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + name = 'newMailAttribute' # str | Name of the extended search attribute configuration to delete. # str | Name of the extended search attribute configuration to delete. + + try: + # Delete Extended Search Attribute + + SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name=name) + # Below is a request that includes all optional parameters + # SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->delete_search_attribute_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-search-attribute-config +List Extended Search Attributes +Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-search-attribute-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**List[SearchAttributeConfig]**](../models/search-attribute-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of attribute configurations in IdentityNow. | List[SearchAttributeConfig] | - | +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 | - | +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 + +```python +from sailpoint.v3.api.search_attribute_configuration_api import SearchAttributeConfigurationApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.search_attribute_config import SearchAttributeConfig +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + 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) + + try: + # List Extended Search Attributes + + results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config() + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(limit, offset) + print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-single-search-attribute-config +Get Extended Search Attribute +Get an extended attribute configuration by name. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-single-search-attribute-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | name | **str** | True | Name of the extended search attribute configuration to retrieve. + +### Return type +[**List[SearchAttributeConfig]**](../models/search-attribute-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Specific attribute configuration in ISC. | List[SearchAttributeConfig] | - | +204 | No content - indicates the request was successful but there is no content to be returned in the response. | | - | +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 + +```python +from sailpoint.v3.api.search_attribute_configuration_api import SearchAttributeConfigurationApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.search_attribute_config import SearchAttributeConfig +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + name = 'newMailAttribute' # str | Name of the extended search attribute configuration to retrieve. # str | Name of the extended search attribute configuration to retrieve. + + try: + # Get Extended Search Attribute + + results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name=name) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name) + print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-search-attribute-config +Update Extended Search Attribute +Update an existing search attribute configuration. +You can patch these fields: +* name * displayName * applicationAttributes + +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-search-attribute-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | name | **str** | True | Name of the search attribute configuration to patch. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | + +### Return type +[**SearchAttributeConfig**](../models/search-attribute-config) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The updated search attribute configuration. | SearchAttributeConfig | - | +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-patch+json + - **Accept**: application/json + +### Example + +```python +from sailpoint.v3.api.search_attribute_configuration_api import SearchAttributeConfigurationApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.json_patch_operation import JsonPatchOperation +from sailpoint.v3.models.search_attribute_config import SearchAttributeConfig +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + name = 'promotedMailAttribute' # str | Name of the search attribute configuration to patch. # str | Name of the search attribute configuration to patch. + json_patch_operation = '''[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}]''' # List[JsonPatchOperation] | + + try: + # Update Extended Search Attribute + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name=name, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name, new_json_patch_operation) + print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->patch_search_attribute_config: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/SegmentsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/SegmentsApi.md new file mode 100644 index 000000000..aa135f39d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/SegmentsApi.md @@ -0,0 +1,365 @@ +--- +id: segments +title: Segments +pagination_label: Segments +sidebar_label: Segments +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Segments', 'Segments'] +slug: /tools/sdk/python/v3/methods/segments +tags: ['SDK', 'Software Development Kit', 'Segments', 'Segments'] +--- + +# sailpoint.v3.SegmentsApi + Use this API to implement and customize access request segment functionality. +With this functionality in place, administrators can create and manage access request segments. +Segments provide organizations with a way to make the access their users have even more granular - this can simply the access request process for the organization's users and improves security by reducing the risk of overprovisoning access. + +Segments represent sets of identities, all grouped by specified identity attributes, who are only able to see and access the access items associated with their segments. +For example, administrators could group all their organization's London office employees into one segment, "London Office Employees," by their shared location. +The administrators could then define the access items the London employees would need, and the identities in the "London Office Employees" would then only be able to see and access those items. + +In Identity Security Cloud, administrators can use the 'Access' drop-down menu and select 'Segments' to reach the 'Access Requests Segments' page. +This page lists all the existing access request segments, along with their statuses, enabled or disabled. +Administrators can use this page to create, edit, enable, disable, and delete segments. +To create a segment, an administrator must provide a name, define the identities grouped in the segment, and define the items the identities in the segment can access. +These items can be access profiles, roles, or entitlements. + +When administrators use the API to create and manage segments, they use a JSON expression in the `visibilityCriteria` object to define the segment's identities and access items. + +Refer to [Managing Access Request Segments](https://documentation.sailpoint.com/saas/help/requests/segments.html) for more information about segments in Identity Security Cloud. + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-segment**](#create-segment) | **POST** `/segments` | Create Segment +[**delete-segment**](#delete-segment) | **DELETE** `/segments/{id}` | Delete Segment by ID +[**get-segment**](#get-segment) | **GET** `/segments/{id}` | Get Segment by ID +[**list-segments**](#list-segments) | **GET** `/segments` | List Segments +[**patch-segment**](#patch-segment) | **PATCH** `/segments/{id}` | Update Segment + + +## create-segment +Create Segment +This API creates a segment. +>**Note:** Segment definitions may take time to propagate to all identities. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-segment) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | segment | [**Segment**](../models/segment) | True | + +### Return type +[**Segment**](../models/segment) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +201 | Segment created | Segment | - | +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 | - | +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 + +```python +from sailpoint.v3.api.segments_api import SegmentsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.segment import Segment +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + segment = '''{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" + } + }, + "name" : "segment-xyz", + "modified" : "2020-01-01T00:00:00Z", + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" + }''' # Segment | + + try: + # Create Segment + new_segment = Segment.from_json(segment) + results = SegmentsApi(api_client).create_segment(segment=new_segment) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).create_segment(new_segment) + print("The response of SegmentsApi->create_segment:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SegmentsApi->create_segment: %s\n" % e) +``` + + + +[[Back to top]](#) + +## delete-segment +Delete Segment by ID +This API deletes the segment specified by the given ID. +>**Note:** that segment deletion may take some time to become effective. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-segment) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The segment ID 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. | 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 + +```python +from sailpoint.v3.api.segments_api import SegmentsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. + + try: + # Delete Segment by ID + + SegmentsApi(api_client).delete_segment(id=id) + # Below is a request that includes all optional parameters + # SegmentsApi(api_client).delete_segment(id) + except Exception as e: + print("Exception when calling SegmentsApi->delete_segment: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-segment +Get Segment by ID +This API returns the segment specified by the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-segment) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The segment ID to retrieve. + +### Return type +[**Segment**](../models/segment) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Segment | Segment | - | +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 + +```python +from sailpoint.v3.api.segments_api import SegmentsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.segment import Segment +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. + + try: + # Get Segment by ID + + results = SegmentsApi(api_client).get_segment(id=id) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).get_segment(id) + print("The response of SegmentsApi->get_segment:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SegmentsApi->get_segment: %s\n" % e) +``` + + + +[[Back to top]](#) + +## list-segments +List Segments +This API returns a list of all segments. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-segments) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + 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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**List[Segment]**](../models/segment) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | List of all segments | List[Segment] | - | +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 | - | +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 + +```python +from sailpoint.v3.api.segments_api import SegmentsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.segment import Segment +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + 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 Segments + + results = SegmentsApi(api_client).list_segments() + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).list_segments(limit, offset, count) + print("The response of SegmentsApi->list_segments:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SegmentsApi->list_segments: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-segment +Update Segment +Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +>**Note:** Changes to a segment may take some time to propagate to all identities. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-segment) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | The segment ID to modify. + Body | request_body | **[]object** | True | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + +### Return type +[**Segment**](../models/segment) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Indicates the PATCH operation succeeded, and returns the segment's new representation. | Segment | - | +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-patch+json + - **Accept**: application/json + +### Example + +```python +from sailpoint.v3.api.segments_api import SegmentsApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.segment import Segment +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to modify. # str | The segment ID to modify. + request_body = '''[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]''' # List[object] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + + try: + # Update Segment + new_request_body = RequestBody.from_json(request_body) + results = SegmentsApi(api_client).patch_segment(id=id, request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).patch_segment(id, new_request_body) + print("The response of SegmentsApi->patch_segment:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SegmentsApi->patch_segment: %s\n" % e) +``` + + + +[[Back to top]](#) + + + diff --git a/docs/tools/sdk/python/Reference/V3/Methods/ServiceDeskIntegrationApi.md b/docs/tools/sdk/python/Reference/V3/Methods/ServiceDeskIntegrationApi.md new file mode 100644 index 000000000..73106dd2c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Methods/ServiceDeskIntegrationApi.md @@ -0,0 +1,716 @@ +--- +id: service-desk-integration +title: Service_Desk_Integration +pagination_label: Service_Desk_Integration +sidebar_label: Service_Desk_Integration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Service_Desk_Integration', 'Service_Desk_Integration'] +slug: /tools/sdk/python/v3/methods/service-desk-integration +tags: ['SDK', 'Software Development Kit', 'Service_Desk_Integration', 'Service_Desk_Integration'] +--- + +# sailpoint.v3.ServiceDeskIntegrationApi + Use this API to build an integration between Identity Security Cloud and a service desk ITSM (IT service management) solution. +Once an administrator builds this integration between Identity Security Cloud and a service desk, users can use Identity Security Cloud to raise and track tickets that are synchronized between Identity Security Cloud and the service desk. + +In Identity Security Cloud, administrators can create a service desk integration (sometimes also called an SDIM, or Service Desk Integration Module) by going to Admin > Connections > Service Desk and selecting 'Create.' + +To create a Generic Service Desk integration, for example, administrators must provide the required information on the General Settings page, the Connectivity and Authentication information, Ticket Creation information, Status Mapping information, and Requester Source information on the Configure page. +Refer to [Integrating SailPoint with Generic Service Desk](https://documentation.sailpoint.com/connectors/generic_sd/help/integrating_generic_service_desk/intro.html) for more information about the process of setting up a Generic Service Desk in Identity Security Cloud. + +Administrators can create various service desk integrations, all with their own nuances. +The following service desk integrations are available: + +- [Atlassian Cloud Jira Service Management](https://documentation.sailpoint.com/connectors/atlassian/jira_cloud/help/integrating_jira_cloud_sd/introduction.html) + +- [Atlassian Server Jira Service Management](https://documentation.sailpoint.com/connectors/atlassian/jira_server/help/integrating_jira_server_sd/introduction.html) + +- [BMC Helix ITSM Service Desk](https://documentation.sailpoint.com/connectors/bmc/helix_ITSM_sd/help/integrating_bmc_helix_itsm_sd/intro.html) + +- [BMC Helix Remedyforce Service Desk](https://documentation.sailpoint.com/connectors/bmc/helix_remedyforce_sd/help/integrating_bmc_helix_remedyforce_sd/intro.html) + +- [Generic Service Desk](https://documentation.sailpoint.com/connectors/generic_sd/help/integrating_generic_service_desk/intro.html) + +- [ServiceNow Service Desk](https://documentation.sailpoint.com/connectors/servicenow/sdim/help/integrating_servicenow_sdim/intro.html) + +- [Zendesk Service Desk](https://documentation.sailpoint.com/connectors/zendesk/help/integrating_zendesk_sd/introduction.html) + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-service-desk-integration**](#create-service-desk-integration) | **POST** `/service-desk-integrations` | Create new Service Desk integration +[**delete-service-desk-integration**](#delete-service-desk-integration) | **DELETE** `/service-desk-integrations/{id}` | Delete a Service Desk integration +[**get-service-desk-integration**](#get-service-desk-integration) | **GET** `/service-desk-integrations/{id}` | Get a Service Desk integration +[**get-service-desk-integration-template**](#get-service-desk-integration-template) | **GET** `/service-desk-integrations/templates/{scriptName}` | Service Desk integration template by scriptName +[**get-service-desk-integration-types**](#get-service-desk-integration-types) | **GET** `/service-desk-integrations/types` | List Service Desk integration types +[**get-service-desk-integrations**](#get-service-desk-integrations) | **GET** `/service-desk-integrations` | List existing Service Desk integrations +[**get-status-check-details**](#get-status-check-details) | **GET** `/service-desk-integrations/status-check-configuration` | Get the time check configuration +[**patch-service-desk-integration**](#patch-service-desk-integration) | **PATCH** `/service-desk-integrations/{id}` | Patch a Service Desk Integration +[**put-service-desk-integration**](#put-service-desk-integration) | **PUT** `/service-desk-integrations/{id}` | Update a Service Desk integration +[**update-status-check-details**](#update-status-check-details) | **PUT** `/service-desk-integrations/status-check-configuration` | Update the time check configuration + + +## create-service-desk-integration +Create new Service Desk integration +Create a new Service Desk integration. + +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-service-desk-integration) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | service_desk_integration_dto | [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) | True | The specifics of a new integration to create + +### Return type +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Details of the created integration | ServiceDeskIntegrationDto | - | +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 + +```python +from sailpoint.v3.api.service_desk_integration_api import ServiceDeskIntegrationApi +from sailpoint.v3.api_client import ApiClient +from sailpoint.v3.models.service_desk_integration_dto import ServiceDeskIntegrationDto +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + service_desk_integration_dto = '''{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n
Geben Sie bei Zeit\u00fcberschreitung bei Verbindung die maximal erlaubte Zeitdauer (in Minuten) f\u00fcr die Verbindung von IdentityNow mit der Quelle ein.
Geben Sie die Host-URL der Delinea-SCIM-Serverquelle ein.
Geben Sie den API-Token der Quelle zur Authentifizierung ein. +sectionInfo_AggregationSettings=Geben Sie die Einstellungen f\u00fcr Ihre Aggregation an.
Geben Sie in das Feld Seitengr\u00f6\u00dfe die Anzahl an Kontoeintr\u00e4gen ein, die auf einer einzelnen Seite aggregiert werden sollen, wenn gro\u00dfe Datens\u00e4tze durchlaufen werden.
\n
Geben Sie im Kontofilter die Bedingungen f\u00fcr den Kontofilter an. Beispiel: userName sw "S"
Geben Sie im Gruppenfilter die Gruppenfilterbedingungen an. Beispiel: displayName sw "S". +placeHolder_accAggregation=userName sw "S" +placeHolder_grpAggregation=displayName sw "S" +placeHolder_host=https://{Delinea_SCIM_Server_host}/v2 +docLinkLabel_AuthenticationSettings=Mehr \u00fcber Verbindungseinstellungen +docLinkLabel_Filters=Mehr \u00fcber Konto- und Gruppenfilter +HostURL=Host-URL +ConnectionTimeout=Zeit\u00fcberschreitung bei Verbindung +API_TOKEN=API-Token +JSONPathMapping=JSON-Path-Attribut-Mapping +FilterConditionForAccounts=Kontofilter +FilterConditionForGroups=Gruppenfilter +Page_Size=Seitengr\u00f6\u00dfe +SchemaAttribute=Schema-Attribut +JSONpath=JSON-Pfad +ShortDesc=Das Integrationsmodul IdentityNow f\u00fcr Delinea Secret Server On-Premise bietet die M\u00f6glichkeit einer tiefen Governance f\u00fcr Konten und Gruppen. Es unterst\u00fctzt au\u00dferdem das End-to-End-Lebenszyklus-Management.}, +connector_metadata={supportedUI=EXTJS, platform=ccg, shortDesc=connector description}, +status='RELEASED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CreateExternalExecuteWorkflow200Response.md b/docs/tools/sdk/python/Reference/V3/Models/CreateExternalExecuteWorkflow200Response.md new file mode 100644 index 000000000..f6d18f72b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CreateExternalExecuteWorkflow200Response.md @@ -0,0 +1,35 @@ +--- +id: create-external-execute-workflow200-response +title: CreateExternalExecuteWorkflow200Response +pagination_label: CreateExternalExecuteWorkflow200Response +sidebar_label: CreateExternalExecuteWorkflow200Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CreateExternalExecuteWorkflow200Response', 'CreateExternalExecuteWorkflow200Response'] +slug: /tools/sdk/python/v3/models/create-external-execute-workflow200-response +tags: ['SDK', 'Software Development Kit', 'CreateExternalExecuteWorkflow200Response', 'CreateExternalExecuteWorkflow200Response'] +--- + +# CreateExternalExecuteWorkflow200Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**workflow_execution_id** | **str** | The workflow execution id | [optional] +**message** | **str** | An error message if any errors occurred | [optional] +} + +## Example + +```python +from sailpoint.v3.models.create_external_execute_workflow200_response import CreateExternalExecuteWorkflow200Response + +create_external_execute_workflow200_response = CreateExternalExecuteWorkflow200Response( +workflow_execution_id='0e11cefa-96e7-4b67-90d0-065bc1da5753', +message='Workflow was not executed externally. Check enabled flag on workflow definition' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CreateExternalExecuteWorkflowRequest.md b/docs/tools/sdk/python/Reference/V3/Models/CreateExternalExecuteWorkflowRequest.md new file mode 100644 index 000000000..7c11f07a0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CreateExternalExecuteWorkflowRequest.md @@ -0,0 +1,33 @@ +--- +id: create-external-execute-workflow-request +title: CreateExternalExecuteWorkflowRequest +pagination_label: CreateExternalExecuteWorkflowRequest +sidebar_label: CreateExternalExecuteWorkflowRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CreateExternalExecuteWorkflowRequest', 'CreateExternalExecuteWorkflowRequest'] +slug: /tools/sdk/python/v3/models/create-external-execute-workflow-request +tags: ['SDK', 'Software Development Kit', 'CreateExternalExecuteWorkflowRequest', 'CreateExternalExecuteWorkflowRequest'] +--- + +# CreateExternalExecuteWorkflowRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**input** | **object** | The input for the workflow | [optional] +} + +## Example + +```python +from sailpoint.v3.models.create_external_execute_workflow_request import CreateExternalExecuteWorkflowRequest + +create_external_execute_workflow_request = CreateExternalExecuteWorkflowRequest( +input={customAttribute1=value1, customAttribute2=value2} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CreateOAuthClientRequest.md b/docs/tools/sdk/python/Reference/V3/Models/CreateOAuthClientRequest.md new file mode 100644 index 000000000..eb0e816db --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CreateOAuthClientRequest.md @@ -0,0 +1,61 @@ +--- +id: create-o-auth-client-request +title: CreateOAuthClientRequest +pagination_label: CreateOAuthClientRequest +sidebar_label: CreateOAuthClientRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CreateOAuthClientRequest', 'CreateOAuthClientRequest'] +slug: /tools/sdk/python/v3/models/create-o-auth-client-request +tags: ['SDK', 'Software Development Kit', 'CreateOAuthClientRequest', 'CreateOAuthClientRequest'] +--- + +# CreateOAuthClientRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**business_name** | **str** | The name of the business the API Client should belong to | [optional] +**homepage_url** | **str** | The homepage URL associated with the owner of the API Client | [optional] +**name** | **str** | A human-readable name for the API Client | [required] +**description** | **str** | A description of the API Client | [required] +**access_token_validity_seconds** | **int** | The number of seconds an access token generated for this API Client is valid for | [required] +**refresh_token_validity_seconds** | **int** | The number of seconds a refresh token generated for this API Client is valid for | [optional] +**redirect_uris** | **[]str** | A list of the approved redirect URIs. Provide one or more URIs when assigning the AUTHORIZATION_CODE grant type to a new OAuth Client. | [optional] +**grant_types** | [**[]GrantType**](grant-type) | A list of OAuth 2.0 grant types this API Client can be used with | [required] +**access_type** | [**AccessType**](access-type) | | [required] +**type** | [**ClientType**](client-type) | | [optional] +**internal** | **bool** | An indicator of whether the API Client can be used for requests internal within the product. | [optional] +**enabled** | **bool** | An indicator of whether the API Client is enabled for use | [required] +**strong_auth_supported** | **bool** | An indicator of whether the API Client supports strong authentication | [optional] +**claims_supported** | **bool** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | [optional] +**scope** | **[]str** | Scopes of the API Client. If no scope is specified, the client will be created with the default scope \"sp:scopes:all\". This means the API Client will have all the rights of the owner who created it. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.create_o_auth_client_request import CreateOAuthClientRequest + +create_o_auth_client_request = CreateOAuthClientRequest( +business_name='Acme-Solar', +homepage_url='http://localhost:12345', +name='Demo API Client', +description='An API client used for the authorization_code, refresh_token, and client_credentials flows', +access_token_validity_seconds=750, +refresh_token_validity_seconds=86400, +redirect_uris=[http://localhost:12345], +grant_types=[AUTHORIZATION_CODE, CLIENT_CREDENTIALS, REFRESH_TOKEN], +access_type='OFFLINE', +type='CONFIDENTIAL', +internal=False, +enabled=True, +strong_auth_supported=False, +claims_supported=False, +scope=[demo:api-client-scope:first, demo:api-client-scope:second] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CreateOAuthClientResponse.md b/docs/tools/sdk/python/Reference/V3/Models/CreateOAuthClientResponse.md new file mode 100644 index 000000000..e2e5396cb --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CreateOAuthClientResponse.md @@ -0,0 +1,69 @@ +--- +id: create-o-auth-client-response +title: CreateOAuthClientResponse +pagination_label: CreateOAuthClientResponse +sidebar_label: CreateOAuthClientResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CreateOAuthClientResponse', 'CreateOAuthClientResponse'] +slug: /tools/sdk/python/v3/models/create-o-auth-client-response +tags: ['SDK', 'Software Development Kit', 'CreateOAuthClientResponse', 'CreateOAuthClientResponse'] +--- + +# CreateOAuthClientResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the OAuth client | [required] +**secret** | **str** | Secret of the OAuth client (This field is only returned on the intial create call.) | [required] +**business_name** | **str** | The name of the business the API Client should belong to | [required] +**homepage_url** | **str** | The homepage URL associated with the owner of the API Client | [required] +**name** | **str** | A human-readable name for the API Client | [required] +**description** | **str** | A description of the API Client | [required] +**access_token_validity_seconds** | **int** | The number of seconds an access token generated for this API Client is valid for | [required] +**refresh_token_validity_seconds** | **int** | The number of seconds a refresh token generated for this API Client is valid for | [required] +**redirect_uris** | **[]str** | A list of the approved redirect URIs used with the authorization_code flow | [required] +**grant_types** | [**[]GrantType**](grant-type) | A list of OAuth 2.0 grant types this API Client can be used with | [required] +**access_type** | [**AccessType**](access-type) | | [required] +**type** | [**ClientType**](client-type) | | [required] +**internal** | **bool** | An indicator of whether the API Client can be used for requests internal to IDN | [required] +**enabled** | **bool** | An indicator of whether the API Client is enabled for use | [required] +**strong_auth_supported** | **bool** | An indicator of whether the API Client supports strong authentication | [required] +**claims_supported** | **bool** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | [required] +**created** | **datetime** | The date and time, down to the millisecond, when the API Client was created | [required] +**modified** | **datetime** | The date and time, down to the millisecond, when the API Client was last updated | [required] +**scope** | **[]str** | Scopes of the API Client. | [required] +} + +## Example + +```python +from sailpoint.v3.models.create_o_auth_client_response import CreateOAuthClientResponse + +create_o_auth_client_response = CreateOAuthClientResponse( +id='2c9180835d2e5168015d32f890ca1581', +secret='5c32dd9b21adb51c77794d46e71de117a1d0ddb36a7ff941fa28014ab7de2cf3', +business_name='Acme-Solar', +homepage_url='http://localhost:12345', +name='Demo API Client', +description='An API client used for the authorization_code, refresh_token, and client_credentials flows', +access_token_validity_seconds=750, +refresh_token_validity_seconds=86400, +redirect_uris=[http://localhost:12345], +grant_types=[AUTHORIZATION_CODE, CLIENT_CREDENTIALS, REFRESH_TOKEN], +access_type='OFFLINE', +type='CONFIDENTIAL', +internal=False, +enabled=True, +strong_auth_supported=False, +claims_supported=False, +created='2017-07-11T18:45:37.098Z', +modified='2018-06-25T20:22:28.104Z', +scope=[demo:api-client-scope:first, demo:api-client-scope:second] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CreatePersonalAccessTokenRequest.md b/docs/tools/sdk/python/Reference/V3/Models/CreatePersonalAccessTokenRequest.md new file mode 100644 index 000000000..d490dd21a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CreatePersonalAccessTokenRequest.md @@ -0,0 +1,38 @@ +--- +id: create-personal-access-token-request +title: CreatePersonalAccessTokenRequest +pagination_label: CreatePersonalAccessTokenRequest +sidebar_label: CreatePersonalAccessTokenRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CreatePersonalAccessTokenRequest', 'CreatePersonalAccessTokenRequest'] +slug: /tools/sdk/python/v3/models/create-personal-access-token-request +tags: ['SDK', 'Software Development Kit', 'CreatePersonalAccessTokenRequest', 'CreatePersonalAccessTokenRequest'] +--- + +# CreatePersonalAccessTokenRequest + +Object for specifying the name of a personal access token to create + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created. | [required] +**scope** | **[]str** | Scopes of the personal access token. If no scope is specified, the token will be created with the default scope \"sp:scopes:all\". This means the personal access token will have all the rights of the owner who created it. | [optional] +**access_token_validity_seconds** | **int** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.create_personal_access_token_request import CreatePersonalAccessTokenRequest + +create_personal_access_token_request = CreatePersonalAccessTokenRequest( +name='NodeJS Integration', +scope=[demo:personal-access-token-scope:first, demo:personal-access-token-scope:second], +access_token_validity_seconds=36900 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CreatePersonalAccessTokenResponse.md b/docs/tools/sdk/python/Reference/V3/Models/CreatePersonalAccessTokenResponse.md new file mode 100644 index 000000000..e25672590 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CreatePersonalAccessTokenResponse.md @@ -0,0 +1,48 @@ +--- +id: create-personal-access-token-response +title: CreatePersonalAccessTokenResponse +pagination_label: CreatePersonalAccessTokenResponse +sidebar_label: CreatePersonalAccessTokenResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CreatePersonalAccessTokenResponse', 'CreatePersonalAccessTokenResponse'] +slug: /tools/sdk/python/v3/models/create-personal-access-token-response +tags: ['SDK', 'Software Development Kit', 'CreatePersonalAccessTokenResponse', 'CreatePersonalAccessTokenResponse'] +--- + +# CreatePersonalAccessTokenResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the personal access token (to be used as the username for Basic Auth). | [required] +**secret** | **str** | The secret of the personal access token (to be used as the password for Basic Auth). | [required] +**scope** | **[]str** | Scopes of the personal access token. | [required] +**name** | **str** | The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. | [required] +**owner** | [**PatOwner**](pat-owner) | | [required] +**created** | **datetime** | The date and time, down to the millisecond, when this personal access token was created. | [required] +**access_token_validity_seconds** | **int** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [required] +} + +## Example + +```python +from sailpoint.v3.models.create_personal_access_token_response import CreatePersonalAccessTokenResponse + +create_personal_access_token_response = CreatePersonalAccessTokenResponse( +id='86f1dc6fe8f54414950454cbb11278fa', +secret='1d1bef2b9f426383447f64f69349fc7cac176042578d205c256ba3f37c59adb9', +scope=[demo:personal-access-token-scope:first, demo:personal-access-token-scope:second], +name='NodeJS Integration', +owner=sailpoint.v3.models.pat_owner.PatOwner( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', ), +created='2017-07-11T18:45:37.098Z', +access_token_validity_seconds=36900 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CreateSavedSearchRequest.md b/docs/tools/sdk/python/Reference/V3/Models/CreateSavedSearchRequest.md new file mode 100644 index 000000000..21a68684c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CreateSavedSearchRequest.md @@ -0,0 +1,53 @@ +--- +id: create-saved-search-request +title: CreateSavedSearchRequest +pagination_label: CreateSavedSearchRequest +sidebar_label: CreateSavedSearchRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CreateSavedSearchRequest', 'CreateSavedSearchRequest'] +slug: /tools/sdk/python/v3/models/create-saved-search-request +tags: ['SDK', 'Software Development Kit', 'CreateSavedSearchRequest', 'CreateSavedSearchRequest'] +--- + +# CreateSavedSearchRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the saved search. | [optional] +**description** | **str** | The description of the saved search. | [optional] +**created** | **datetime** | A date-time in ISO-8601 format | [optional] +**modified** | **datetime** | A date-time in ISO-8601 format | [optional] +**indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | [required] +**columns** | [**map[string]List[Column]**](https://docs.python.org/3/tutorial/datastructures.html#more-on-lists) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional] +**query** | **str** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | [required] +**fields** | **[]str** | The fields to be searched against in a multi-field query. | [optional] +**order_by** | **map[string]List[str]** | Sort by index. This takes precedence over the `sort` property. | [optional] +**sort** | **[]str** | The fields to be used to sort the search results. | [optional] +**filters** | [**SavedSearchDetailFilters**](saved-search-detail-filters) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.create_saved_search_request import CreateSavedSearchRequest + +create_saved_search_request = CreateSavedSearchRequest( +name='Disabled accounts', +description='Disabled accounts', +created='2018-06-25T20:22:28.104Z', +modified='2018-06-25T20:22:28.104Z', +indices=[identities], +columns={identity=[{field=displayName, header=Display Name}, {field=e-mail, header=Work Email}]}, +query='@accounts(disabled:true)', +fields=[disabled], +order_by={identity=[lastName, firstName], role=[name]}, +sort=[displayName], +filters= +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CreateScheduledSearchRequest.md b/docs/tools/sdk/python/Reference/V3/Models/CreateScheduledSearchRequest.md new file mode 100644 index 000000000..316673b18 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CreateScheduledSearchRequest.md @@ -0,0 +1,61 @@ +--- +id: create-scheduled-search-request +title: CreateScheduledSearchRequest +pagination_label: CreateScheduledSearchRequest +sidebar_label: CreateScheduledSearchRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CreateScheduledSearchRequest', 'CreateScheduledSearchRequest'] +slug: /tools/sdk/python/v3/models/create-scheduled-search-request +tags: ['SDK', 'Software Development Kit', 'CreateScheduledSearchRequest', 'CreateScheduledSearchRequest'] +--- + +# CreateScheduledSearchRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the scheduled search. | [optional] +**description** | **str** | The description of the scheduled search. | [optional] +**saved_search_id** | **str** | The ID of the saved search that will be executed. | [required] +**created** | **datetime** | The date the scheduled search was initially created. | [optional] [readonly] +**modified** | **datetime** | The last date the scheduled search was modified. | [optional] [readonly] +**schedule** | [**Schedule1**](schedule1) | | [required] +**recipients** | [**[]SearchScheduleRecipientsInner**](search-schedule-recipients-inner) | A list of identities that should receive the scheduled search report via email. | [required] +**enabled** | **bool** | Indicates if the scheduled search is enabled. | [optional] [default to False] +**email_empty_results** | **bool** | Indicates if email generation should occur when search returns no results. | [optional] [default to False] +**display_query_details** | **bool** | Indicates if the generated email should include the query and search results preview (which could include PII). | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v3.models.create_scheduled_search_request import CreateScheduledSearchRequest + +create_scheduled_search_request = CreateScheduledSearchRequest( +name='Daily disabled accounts', +description='Daily disabled accounts', +saved_search_id='554f1511-f0a1-4744-ab14-599514d3e57c', +created='2018-06-25T20:22:28.104Z', +modified='2018-06-25T20:22:28.104Z', +schedule=sailpoint.v3.models.schedule_1.Schedule_1( + type = 'WEEKLY', + months = null, + days = null, + hours = null, + expiration = '2018-06-25T20:22:28.104Z', + time_zone_id = 'America/Chicago', ), +recipients=[ + sailpoint.v3.models.search_schedule_recipients_inner.SearchSchedule_recipients_inner( + type = 'IDENTITY', + id = '2c9180867624cbd7017642d8c8c81f67', ) + ], +enabled=False, +email_empty_results=False, +display_query_details=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CreateUploadedConfigurationRequest.md b/docs/tools/sdk/python/Reference/V3/Models/CreateUploadedConfigurationRequest.md new file mode 100644 index 000000000..7f6086a6b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CreateUploadedConfigurationRequest.md @@ -0,0 +1,35 @@ +--- +id: create-uploaded-configuration-request +title: CreateUploadedConfigurationRequest +pagination_label: CreateUploadedConfigurationRequest +sidebar_label: CreateUploadedConfigurationRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CreateUploadedConfigurationRequest', 'CreateUploadedConfigurationRequest'] +slug: /tools/sdk/python/v3/models/create-uploaded-configuration-request +tags: ['SDK', 'Software Development Kit', 'CreateUploadedConfigurationRequest', 'CreateUploadedConfigurationRequest'] +--- + +# CreateUploadedConfigurationRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | **bytearray** | JSON file containing the objects to be imported. | [required] +**name** | **str** | Name that will be assigned to the uploaded configuration file. | [required] +} + +## Example + +```python +from sailpoint.v3.models.create_uploaded_configuration_request import CreateUploadedConfigurationRequest + +create_uploaded_configuration_request = CreateUploadedConfigurationRequest( +data=bytes(b'blah'), +name='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CreateWorkflowRequest.md b/docs/tools/sdk/python/Reference/V3/Models/CreateWorkflowRequest.md new file mode 100644 index 000000000..cb4e8ed96 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CreateWorkflowRequest.md @@ -0,0 +1,51 @@ +--- +id: create-workflow-request +title: CreateWorkflowRequest +pagination_label: CreateWorkflowRequest +sidebar_label: CreateWorkflowRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CreateWorkflowRequest', 'CreateWorkflowRequest'] +slug: /tools/sdk/python/v3/models/create-workflow-request +tags: ['SDK', 'Software Development Kit', 'CreateWorkflowRequest', 'CreateWorkflowRequest'] +--- + +# CreateWorkflowRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the workflow | [required] +**owner** | [**WorkflowBodyOwner**](workflow-body-owner) | | [optional] +**description** | **str** | Description of what the workflow accomplishes | [optional] +**definition** | [**WorkflowDefinition**](workflow-definition) | | [optional] +**enabled** | **bool** | Enable or disable the workflow. Workflows cannot be created in an enabled state. | [optional] [default to False] +**trigger** | [**WorkflowTrigger**](workflow-trigger) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.create_workflow_request import CreateWorkflowRequest + +create_workflow_request = CreateWorkflowRequest( +name='Send Email', +owner=sailpoint.v3.models.workflow_body_owner.WorkflowBody_owner( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), +description='Send an email to the identity who's attributes changed.', +definition=sailpoint.v3.models.workflow_definition.WorkflowDefinition( + start = 'Send Email Test', + steps = {Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=ACTION}, success={type=success}}, ), +enabled=False, +trigger=sailpoint.v3.models.workflow_trigger.WorkflowTrigger( + type = 'EVENT', + display_name = '', + attributes = null, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/CriteriaType.md b/docs/tools/sdk/python/Reference/V3/Models/CriteriaType.md new file mode 100644 index 000000000..ad981a3ae --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/CriteriaType.md @@ -0,0 +1,41 @@ +--- +id: criteria-type +title: CriteriaType +pagination_label: CriteriaType +sidebar_label: CriteriaType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'CriteriaType', 'CriteriaType'] +slug: /tools/sdk/python/v3/models/criteria-type +tags: ['SDK', 'Software Development Kit', 'CriteriaType', 'CriteriaType'] +--- + +# CriteriaType + +Type of the criteria in the filter. The `COMPOSITE` filter can contain multiple filters in an AND/OR relationship. + +## Enum + +* `COMPOSITE` (value: `'COMPOSITE'`) + +* `ROLE` (value: `'ROLE'`) + +* `IDENTITY` (value: `'IDENTITY'`) + +* `IDENTITY_ATTRIBUTE` (value: `'IDENTITY_ATTRIBUTE'`) + +* `ENTITLEMENT` (value: `'ENTITLEMENT'`) + +* `ACCESS_PROFILE` (value: `'ACCESS_PROFILE'`) + +* `SOURCE` (value: `'SOURCE'`) + +* `ACCOUNT` (value: `'ACCOUNT'`) + +* `AGGREGATED_ENTITLEMENT` (value: `'AGGREGATED_ENTITLEMENT'`) + +* `INVALID_CERTIFIABLE_ENTITY` (value: `'INVALID_CERTIFIABLE_ENTITY'`) + +* `INVALID_CERTIFIABLE_BUNDLE` (value: `'INVALID_CERTIFIABLE_BUNDLE'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/DataAccess.md b/docs/tools/sdk/python/Reference/V3/Models/DataAccess.md new file mode 100644 index 000000000..145b88193 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/DataAccess.md @@ -0,0 +1,46 @@ +--- +id: data-access +title: DataAccess +pagination_label: DataAccess +sidebar_label: DataAccess +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DataAccess', 'DataAccess'] +slug: /tools/sdk/python/v3/models/data-access +tags: ['SDK', 'Software Development Kit', 'DataAccess', 'DataAccess'] +--- + +# DataAccess + +DAS data for the entitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**policies** | [**[]DataAccessPoliciesInner**](data-access-policies-inner) | List of classification policies that apply to resources the entitlement \\ groups has access to | [optional] +**categories** | [**[]DataAccessCategoriesInner**](data-access-categories-inner) | List of classification categories that apply to resources the entitlement \\ groups has access to | [optional] +**impact_score** | [**DataAccessImpactScore**](data-access-impact-score) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.data_access import DataAccess + +data_access = DataAccess( +policies=[ + sailpoint.v3.models.data_access_policies_inner.DataAccess_policies_inner( + value = 'GDPR-20', ) + ], +categories=[ + sailpoint.v3.models.data_access_categories_inner.DataAccess_categories_inner( + value = 'email-7', + match_count = 10, ) + ], +impact_score=sailpoint.v3.models.data_access_impact_score.DataAccess_impactScore( + value = 'Medium', ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/DataAccessCategoriesInner.md b/docs/tools/sdk/python/Reference/V3/Models/DataAccessCategoriesInner.md new file mode 100644 index 000000000..baef1f324 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/DataAccessCategoriesInner.md @@ -0,0 +1,35 @@ +--- +id: data-access-categories-inner +title: DataAccessCategoriesInner +pagination_label: DataAccessCategoriesInner +sidebar_label: DataAccessCategoriesInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DataAccessCategoriesInner', 'DataAccessCategoriesInner'] +slug: /tools/sdk/python/v3/models/data-access-categories-inner +tags: ['SDK', 'Software Development Kit', 'DataAccessCategoriesInner', 'DataAccessCategoriesInner'] +--- + +# DataAccessCategoriesInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | Value of the category | [optional] +**match_count** | **int** | Number of matched for each category | [optional] +} + +## Example + +```python +from sailpoint.v3.models.data_access_categories_inner import DataAccessCategoriesInner + +data_access_categories_inner = DataAccessCategoriesInner( +value='email-7', +match_count=10 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/DataAccessImpactScore.md b/docs/tools/sdk/python/Reference/V3/Models/DataAccessImpactScore.md new file mode 100644 index 000000000..7b170c2ba --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/DataAccessImpactScore.md @@ -0,0 +1,33 @@ +--- +id: data-access-impact-score +title: DataAccessImpactScore +pagination_label: DataAccessImpactScore +sidebar_label: DataAccessImpactScore +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DataAccessImpactScore', 'DataAccessImpactScore'] +slug: /tools/sdk/python/v3/models/data-access-impact-score +tags: ['SDK', 'Software Development Kit', 'DataAccessImpactScore', 'DataAccessImpactScore'] +--- + +# DataAccessImpactScore + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | Impact Score for this data | [optional] +} + +## Example + +```python +from sailpoint.v3.models.data_access_impact_score import DataAccessImpactScore + +data_access_impact_score = DataAccessImpactScore( +value='Medium' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/DataAccessPoliciesInner.md b/docs/tools/sdk/python/Reference/V3/Models/DataAccessPoliciesInner.md new file mode 100644 index 000000000..2c1a77c5c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/DataAccessPoliciesInner.md @@ -0,0 +1,33 @@ +--- +id: data-access-policies-inner +title: DataAccessPoliciesInner +pagination_label: DataAccessPoliciesInner +sidebar_label: DataAccessPoliciesInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DataAccessPoliciesInner', 'DataAccessPoliciesInner'] +slug: /tools/sdk/python/v3/models/data-access-policies-inner +tags: ['SDK', 'Software Development Kit', 'DataAccessPoliciesInner', 'DataAccessPoliciesInner'] +--- + +# DataAccessPoliciesInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | Value of the policy | [optional] +} + +## Example + +```python +from sailpoint.v3.models.data_access_policies_inner import DataAccessPoliciesInner + +data_access_policies_inner = DataAccessPoliciesInner( +value='GDPR-20' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/DeleteNonEmployeeRecordsInBulkRequest.md b/docs/tools/sdk/python/Reference/V3/Models/DeleteNonEmployeeRecordsInBulkRequest.md new file mode 100644 index 000000000..7510139c5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/DeleteNonEmployeeRecordsInBulkRequest.md @@ -0,0 +1,33 @@ +--- +id: delete-non-employee-records-in-bulk-request +title: DeleteNonEmployeeRecordsInBulkRequest +pagination_label: DeleteNonEmployeeRecordsInBulkRequest +sidebar_label: DeleteNonEmployeeRecordsInBulkRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DeleteNonEmployeeRecordsInBulkRequest', 'DeleteNonEmployeeRecordsInBulkRequest'] +slug: /tools/sdk/python/v3/models/delete-non-employee-records-in-bulk-request +tags: ['SDK', 'Software Development Kit', 'DeleteNonEmployeeRecordsInBulkRequest', 'DeleteNonEmployeeRecordsInBulkRequest'] +--- + +# DeleteNonEmployeeRecordsInBulkRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ids** | **[]str** | List of non-employee ids. | [required] +} + +## Example + +```python +from sailpoint.v3.models.delete_non_employee_records_in_bulk_request import DeleteNonEmployeeRecordsInBulkRequest + +delete_non_employee_records_in_bulk_request = DeleteNonEmployeeRecordsInBulkRequest( +ids=[2b838de9-db9b-abcf-e646-d4f274ad4238, 2d838de9-db9b-abcf-e646-d4f274ad4238] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/DeleteSource202Response.md b/docs/tools/sdk/python/Reference/V3/Models/DeleteSource202Response.md new file mode 100644 index 000000000..73af123f7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/DeleteSource202Response.md @@ -0,0 +1,37 @@ +--- +id: delete-source202-response +title: DeleteSource202Response +pagination_label: DeleteSource202Response +sidebar_label: DeleteSource202Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DeleteSource202Response', 'DeleteSource202Response'] +slug: /tools/sdk/python/v3/models/delete-source202-response +tags: ['SDK', 'Software Development Kit', 'DeleteSource202Response', 'DeleteSource202Response'] +--- + +# DeleteSource202Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'TASK_RESULT' ] | Type of object being referenced. | [optional] +**id** | **str** | Task result ID. | [optional] +**name** | **str** | Task result's human-readable display name (this should be null/empty). | [optional] +} + +## Example + +```python +from sailpoint.v3.models.delete_source202_response import DeleteSource202Response + +delete_source202_response = DeleteSource202Response( +type='TASK_RESULT', +id='2c91808779ecf55b0179f720942f181a', +name='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/DeleteVendorConnectorMapping200Response.md b/docs/tools/sdk/python/Reference/V3/Models/DeleteVendorConnectorMapping200Response.md new file mode 100644 index 000000000..ad5e9bb61 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/DeleteVendorConnectorMapping200Response.md @@ -0,0 +1,33 @@ +--- +id: delete-vendor-connector-mapping200-response +title: DeleteVendorConnectorMapping200Response +pagination_label: DeleteVendorConnectorMapping200Response +sidebar_label: DeleteVendorConnectorMapping200Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DeleteVendorConnectorMapping200Response', 'DeleteVendorConnectorMapping200Response'] +slug: /tools/sdk/python/v3/models/delete-vendor-connector-mapping200-response +tags: ['SDK', 'Software Development Kit', 'DeleteVendorConnectorMapping200Response', 'DeleteVendorConnectorMapping200Response'] +--- + +# DeleteVendorConnectorMapping200Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**count** | **int** | The number of vendor connector mappings successfully deleted. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.delete_vendor_connector_mapping200_response import DeleteVendorConnectorMapping200Response + +delete_vendor_connector_mapping200_response = DeleteVendorConnectorMapping200Response( +count=1 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/DependantAppConnections.md b/docs/tools/sdk/python/Reference/V3/Models/DependantAppConnections.md new file mode 100644 index 000000000..410f33f77 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/DependantAppConnections.md @@ -0,0 +1,61 @@ +--- +id: dependant-app-connections +title: DependantAppConnections +pagination_label: DependantAppConnections +sidebar_label: DependantAppConnections +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DependantAppConnections', 'DependantAppConnections'] +slug: /tools/sdk/python/v3/models/dependant-app-connections +tags: ['SDK', 'Software Development Kit', 'DependantAppConnections', 'DependantAppConnections'] +--- + +# DependantAppConnections + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cloud_app_id** | **str** | Id of the connected Application | [optional] +**description** | **str** | Description of the connected Application | [optional] +**enabled** | **bool** | Is the Application enabled | [optional] [default to True] +**provision_request_enabled** | **bool** | Is Provisioning enabled for connected Application | [optional] [default to True] +**account_source** | [**DependantAppConnectionsAccountSource**](dependant-app-connections-account-source) | | [optional] +**launcher_count** | **int** | The amount of launchers for connected Application (long type) | [optional] +**match_all_account** | **bool** | Is Provisioning enabled for connected Application | [optional] [default to False] +**owner** | [**[]BaseReferenceDto**](base-reference-dto) | The owner of the connected Application | [optional] +**app_center_enabled** | **bool** | Is App Center enabled for connected Application | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v3.models.dependant_app_connections import DependantAppConnections + +dependant_app_connections = DependantAppConnections( +cloud_app_id='9e3cdd80edf84f119327df8bbd5bb5ac', +description='This is a Sailpoint application', +enabled=True, +provision_request_enabled=True, +account_source=sailpoint.v3.models.dependant_app_connections_account_source.DependantAppConnections_accountSource( + use_for_password_management = False, + password_policies = [ + sailpoint.v3.models.dependant_app_connections_account_source_password_policies_inner.DependantAppConnections_accountSource_passwordPolicies_inner( + type = 'PASSWORD_POLICY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'Policy ODS', ) + ], ), +launcher_count=100, +match_all_account=True, +owner=[ + sailpoint.v3.models.base_reference_dto.BaseReferenceDto( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ) + ], +app_center_enabled=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/DependantAppConnectionsAccountSource.md b/docs/tools/sdk/python/Reference/V3/Models/DependantAppConnectionsAccountSource.md new file mode 100644 index 000000000..ee5e8d08b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/DependantAppConnectionsAccountSource.md @@ -0,0 +1,41 @@ +--- +id: dependant-app-connections-account-source +title: DependantAppConnectionsAccountSource +pagination_label: DependantAppConnectionsAccountSource +sidebar_label: DependantAppConnectionsAccountSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DependantAppConnectionsAccountSource', 'DependantAppConnectionsAccountSource'] +slug: /tools/sdk/python/v3/models/dependant-app-connections-account-source +tags: ['SDK', 'Software Development Kit', 'DependantAppConnectionsAccountSource', 'DependantAppConnectionsAccountSource'] +--- + +# DependantAppConnectionsAccountSource + +The Account Source of the connected Application + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**use_for_password_management** | **bool** | Use this Account Source for password management | [optional] [default to False] +**password_policies** | [**[]DependantAppConnectionsAccountSourcePasswordPoliciesInner**](dependant-app-connections-account-source-password-policies-inner) | A list of Password Policies for this Account Source | [optional] +} + +## Example + +```python +from sailpoint.v3.models.dependant_app_connections_account_source import DependantAppConnectionsAccountSource + +dependant_app_connections_account_source = DependantAppConnectionsAccountSource( +use_for_password_management=False, +password_policies=[ + sailpoint.v3.models.dependant_app_connections_account_source_password_policies_inner.DependantAppConnections_accountSource_passwordPolicies_inner( + type = 'PASSWORD_POLICY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'Policy ODS', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/DependantAppConnectionsAccountSourcePasswordPoliciesInner.md b/docs/tools/sdk/python/Reference/V3/Models/DependantAppConnectionsAccountSourcePasswordPoliciesInner.md new file mode 100644 index 000000000..129065ad9 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/DependantAppConnectionsAccountSourcePasswordPoliciesInner.md @@ -0,0 +1,37 @@ +--- +id: dependant-app-connections-account-source-password-policies-inner +title: DependantAppConnectionsAccountSourcePasswordPoliciesInner +pagination_label: DependantAppConnectionsAccountSourcePasswordPoliciesInner +sidebar_label: DependantAppConnectionsAccountSourcePasswordPoliciesInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DependantAppConnectionsAccountSourcePasswordPoliciesInner', 'DependantAppConnectionsAccountSourcePasswordPoliciesInner'] +slug: /tools/sdk/python/v3/models/dependant-app-connections-account-source-password-policies-inner +tags: ['SDK', 'Software Development Kit', 'DependantAppConnectionsAccountSourcePasswordPoliciesInner', 'DependantAppConnectionsAccountSourcePasswordPoliciesInner'] +--- + +# DependantAppConnectionsAccountSourcePasswordPoliciesInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | DTO type | [optional] +**id** | **str** | ID of the object to which this reference applies | [optional] +**name** | **str** | Human-readable display name of the object to which this reference applies | [optional] +} + +## Example + +```python +from sailpoint.v3.models.dependant_app_connections_account_source_password_policies_inner import DependantAppConnectionsAccountSourcePasswordPoliciesInner + +dependant_app_connections_account_source_password_policies_inner = DependantAppConnectionsAccountSourcePasswordPoliciesInner( +type='PASSWORD_POLICY', +id='2c91808568c529c60168cca6f90c1313', +name='Policy ODS' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/DependantConnectionsMissingDto.md b/docs/tools/sdk/python/Reference/V3/Models/DependantConnectionsMissingDto.md new file mode 100644 index 000000000..56020ce9b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/DependantConnectionsMissingDto.md @@ -0,0 +1,35 @@ +--- +id: dependant-connections-missing-dto +title: DependantConnectionsMissingDto +pagination_label: DependantConnectionsMissingDto +sidebar_label: DependantConnectionsMissingDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DependantConnectionsMissingDto', 'DependantConnectionsMissingDto'] +slug: /tools/sdk/python/v3/models/dependant-connections-missing-dto +tags: ['SDK', 'Software Development Kit', 'DependantConnectionsMissingDto', 'DependantConnectionsMissingDto'] +--- + +# DependantConnectionsMissingDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**dependency_type** | **Enum** [ 'identityProfiles', 'credentialProfiles', 'mappingProfiles', 'sourceAttributes', 'dependantCustomTransforms', 'dependantApps' ] | The type of dependency type that is missing in the SourceConnections | [optional] +**reason** | **str** | The reason why this dependency is missing | [optional] +} + +## Example + +```python +from sailpoint.v3.models.dependant_connections_missing_dto import DependantConnectionsMissingDto + +dependant_connections_missing_dto = DependantConnectionsMissingDto( +dependency_type='dependantApps', +reason='If there was an error retrieving any dependencies, it would lbe listed here' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/DimensionRef.md b/docs/tools/sdk/python/Reference/V3/Models/DimensionRef.md new file mode 100644 index 000000000..3e56b9015 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/DimensionRef.md @@ -0,0 +1,37 @@ +--- +id: dimension-ref +title: DimensionRef +pagination_label: DimensionRef +sidebar_label: DimensionRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DimensionRef', 'DimensionRef'] +slug: /tools/sdk/python/v3/models/dimension-ref +tags: ['SDK', 'Software Development Kit', 'DimensionRef', 'DimensionRef'] +--- + +# DimensionRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'DIMENSION' ] | The type of the object to which this reference applies | [optional] +**id** | **str** | ID of the object to which this reference applies | [optional] +**name** | **str** | Human-readable display name of the object to which this reference applies | [optional] +} + +## Example + +```python +from sailpoint.v3.models.dimension_ref import DimensionRef + +dimension_ref = DimensionRef( +type='DIMENSION', +id='2c91808568c529c60168cca6f90c1313', +name='Role 2' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/DisplayReference.md b/docs/tools/sdk/python/Reference/V3/Models/DisplayReference.md new file mode 100644 index 000000000..c27eab40f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/DisplayReference.md @@ -0,0 +1,37 @@ +--- +id: display-reference +title: DisplayReference +pagination_label: DisplayReference +sidebar_label: DisplayReference +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DisplayReference', 'DisplayReference'] +slug: /tools/sdk/python/v3/models/display-reference +tags: ['SDK', 'Software Development Kit', 'DisplayReference', 'DisplayReference'] +--- + +# DisplayReference + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the referenced object. | [optional] +**name** | **str** | The human readable name of the referenced object. | [optional] +**display_name** | **str** | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.display_reference import DisplayReference + +display_reference = DisplayReference( +id='2c91808568c529c60168cca6f90c1313', +name='John Doe', +display_name='John Q. Doe' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/DtoType.md b/docs/tools/sdk/python/Reference/V3/Models/DtoType.md new file mode 100644 index 000000000..442936f08 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/DtoType.md @@ -0,0 +1,77 @@ +--- +id: dto-type +title: DtoType +pagination_label: DtoType +sidebar_label: DtoType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DtoType', 'DtoType'] +slug: /tools/sdk/python/v3/models/dto-type +tags: ['SDK', 'Software Development Kit', 'DtoType', 'DtoType'] +--- + +# DtoType + +An enumeration of the types of DTOs supported within the IdentityNow infrastructure. + +## Enum + +* `ACCOUNT_CORRELATION_CONFIG` (value: `'ACCOUNT_CORRELATION_CONFIG'`) + +* `ACCESS_PROFILE` (value: `'ACCESS_PROFILE'`) + +* `ACCESS_REQUEST_APPROVAL` (value: `'ACCESS_REQUEST_APPROVAL'`) + +* `ACCOUNT` (value: `'ACCOUNT'`) + +* `APPLICATION` (value: `'APPLICATION'`) + +* `CAMPAIGN` (value: `'CAMPAIGN'`) + +* `CAMPAIGN_FILTER` (value: `'CAMPAIGN_FILTER'`) + +* `CERTIFICATION` (value: `'CERTIFICATION'`) + +* `CLUSTER` (value: `'CLUSTER'`) + +* `CONNECTOR_SCHEMA` (value: `'CONNECTOR_SCHEMA'`) + +* `ENTITLEMENT` (value: `'ENTITLEMENT'`) + +* `GOVERNANCE_GROUP` (value: `'GOVERNANCE_GROUP'`) + +* `IDENTITY` (value: `'IDENTITY'`) + +* `IDENTITY_PROFILE` (value: `'IDENTITY_PROFILE'`) + +* `IDENTITY_REQUEST` (value: `'IDENTITY_REQUEST'`) + +* `MACHINE_IDENTITY` (value: `'MACHINE_IDENTITY'`) + +* `LIFECYCLE_STATE` (value: `'LIFECYCLE_STATE'`) + +* `PASSWORD_POLICY` (value: `'PASSWORD_POLICY'`) + +* `ROLE` (value: `'ROLE'`) + +* `RULE` (value: `'RULE'`) + +* `SOD_POLICY` (value: `'SOD_POLICY'`) + +* `SOURCE` (value: `'SOURCE'`) + +* `TAG` (value: `'TAG'`) + +* `TAG_CATEGORY` (value: `'TAG_CATEGORY'`) + +* `TASK_RESULT` (value: `'TASK_RESULT'`) + +* `REPORT_RESULT` (value: `'REPORT_RESULT'`) + +* `SOD_VIOLATION` (value: `'SOD_VIOLATION'`) + +* `ACCOUNT_ACTIVITY` (value: `'ACCOUNT_ACTIVITY'`) + +* `WORKGROUP` (value: `'WORKGROUP'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/DuoVerificationRequest.md b/docs/tools/sdk/python/Reference/V3/Models/DuoVerificationRequest.md new file mode 100644 index 000000000..86feb27d2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/DuoVerificationRequest.md @@ -0,0 +1,35 @@ +--- +id: duo-verification-request +title: DuoVerificationRequest +pagination_label: DuoVerificationRequest +sidebar_label: DuoVerificationRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'DuoVerificationRequest', 'DuoVerificationRequest'] +slug: /tools/sdk/python/v3/models/duo-verification-request +tags: ['SDK', 'Software Development Kit', 'DuoVerificationRequest', 'DuoVerificationRequest'] +--- + +# DuoVerificationRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**user_id** | **str** | User id for Verification request. | [required] +**signed_response** | **str** | User id for Verification request. | [required] +} + +## Example + +```python +from sailpoint.v3.models.duo_verification_request import DuoVerificationRequest + +duo_verification_request = DuoVerificationRequest( +user_id='2c9180947f0ef465017f215cbcfd004b', +signed_response='AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/EmailNotificationOption.md b/docs/tools/sdk/python/Reference/V3/Models/EmailNotificationOption.md new file mode 100644 index 000000000..810737250 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/EmailNotificationOption.md @@ -0,0 +1,40 @@ +--- +id: email-notification-option +title: EmailNotificationOption +pagination_label: EmailNotificationOption +sidebar_label: EmailNotificationOption +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EmailNotificationOption', 'EmailNotificationOption'] +slug: /tools/sdk/python/v3/models/email-notification-option +tags: ['SDK', 'Software Development Kit', 'EmailNotificationOption', 'EmailNotificationOption'] +--- + +# EmailNotificationOption + +This is used for representing email configuration for a lifecycle state + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**notify_managers** | **bool** | If true, then the manager is notified of the lifecycle state change. | [optional] [default to False] +**notify_all_admins** | **bool** | If true, then all the admins are notified of the lifecycle state change. | [optional] [default to False] +**notify_specific_users** | **bool** | If true, then the users specified in \"emailAddressList\" below are notified of lifecycle state change. | [optional] [default to False] +**email_address_list** | **[]str** | List of user email addresses. If \"notifySpecificUsers\" option is true, then these users are notified of lifecycle state change. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.email_notification_option import EmailNotificationOption + +email_notification_option = EmailNotificationOption( +notify_managers=True, +notify_all_admins=True, +notify_specific_users=True, +email_address_list=[test@test.com, test2@test.com] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Entitlement.md b/docs/tools/sdk/python/Reference/V3/Models/Entitlement.md new file mode 100644 index 000000000..66269bce6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Entitlement.md @@ -0,0 +1,97 @@ +--- +id: entitlement +title: Entitlement +pagination_label: Entitlement +sidebar_label: Entitlement +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Entitlement', 'Entitlement'] +slug: /tools/sdk/python/v3/models/entitlement +tags: ['SDK', 'Software Development Kit', 'Entitlement', 'Entitlement'] +--- + +# Entitlement + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The entitlement id | [optional] +**name** | **str** | The entitlement name | [optional] +**attribute** | **str** | The entitlement attribute name | [optional] +**value** | **str** | The value of the entitlement | [optional] +**source_schema_object_type** | **str** | The object type of the entitlement from the source schema | [optional] +**description** | **str** | The description of the entitlement | [optional] +**privileged** | **bool** | True if the entitlement is privileged | [optional] +**cloud_governed** | **bool** | True if the entitlement is cloud governed | [optional] +**requestable** | **bool** | True if the entitlement is able to be directly requested | [optional] [default to False] +**owner** | [**EntitlementOwner**](entitlement-owner) | | [optional] +**manually_updated_fields** | **map[string]object** | A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated. | [optional] +**access_model_metadata** | [**EntitlementAccessModelMetadata**](entitlement-access-model-metadata) | | [optional] +**created** | **datetime** | Time when the entitlement was created | [optional] +**modified** | **datetime** | Time when the entitlement was last modified | [optional] +**source** | [**EntitlementSource**](entitlement-source) | | [optional] +**attributes** | **map[string]object** | A map of free-form key-value pairs from the source system | [optional] +**segments** | **[]str** | List of IDs of segments, if any, to which this Entitlement is assigned. | [optional] +**direct_permissions** | [**[]PermissionDto**](permission-dto) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.entitlement import Entitlement + +entitlement = Entitlement( +id='2c91808874ff91550175097daaec161c', +name='LauncherTest2', +attribute='memberOf', +value='CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local', +source_schema_object_type='group', +description='CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local', +privileged=True, +cloud_governed=True, +requestable=True, +owner=sailpoint.v3.models.entitlement_owner.Entitlement_owner( + id = '2c9180827ca885d7017ca8ce28a000eb', + type = 'IDENTITY', + name = 'john.doe', ), +manually_updated_fields={DISPLAY_NAME=true, DESCRIPTION=true}, +access_model_metadata=sailpoint.v3.models.entitlement_access_model_metadata.Entitlement_accessModelMetadata( + attributes = [ + sailpoint.v3.models.access_model_metadata.AccessModelMetadata( + key = 'iscCsp', + name = 'CSP', + multiselect = True, + status = 'active', + type = 'governance', + object_types = [ + 'general' + ], + description = 'Indicates the type of deployment environment of an access item.', + values = [ + sailpoint.v3.models.access_model_metadata_values_inner.AccessModelMetadata_values_inner( + value = 'development', + name = 'Development', + status = 'active', ) + ], ) + ], ), +created='2020-10-08T18:33:52.029Z', +modified='2020-10-08T18:33:52.029Z', +source=sailpoint.v3.models.entitlement_source.Entitlement_source( + id = '2c9180827ca885d7017ca8ce28a000eb', + type = 'SOURCE', + name = 'ODS-AD-Source', ), +attributes={fieldName=fieldValue}, +segments=[f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a], +direct_permissions=[ + sailpoint.v3.models.permission_dto.PermissionDto( + rights = [ + 'SELECT' + ], + target = 'SYS.GV_$TRANSACTION', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/EntitlementAccessModelMetadata.md b/docs/tools/sdk/python/Reference/V3/Models/EntitlementAccessModelMetadata.md new file mode 100644 index 000000000..a670197d2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/EntitlementAccessModelMetadata.md @@ -0,0 +1,51 @@ +--- +id: entitlement-access-model-metadata +title: EntitlementAccessModelMetadata +pagination_label: EntitlementAccessModelMetadata +sidebar_label: EntitlementAccessModelMetadata +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementAccessModelMetadata', 'EntitlementAccessModelMetadata'] +slug: /tools/sdk/python/v3/models/entitlement-access-model-metadata +tags: ['SDK', 'Software Development Kit', 'EntitlementAccessModelMetadata', 'EntitlementAccessModelMetadata'] +--- + +# EntitlementAccessModelMetadata + +Additional data to classify the entitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**[]AccessModelMetadata**](access-model-metadata) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.entitlement_access_model_metadata import EntitlementAccessModelMetadata + +entitlement_access_model_metadata = EntitlementAccessModelMetadata( +attributes=[ + sailpoint.v3.models.access_model_metadata.AccessModelMetadata( + key = 'iscCsp', + name = 'CSP', + multiselect = True, + status = 'active', + type = 'governance', + object_types = [ + 'general' + ], + description = 'Indicates the type of deployment environment of an access item.', + values = [ + sailpoint.v3.models.access_model_metadata_values_inner.AccessModelMetadata_values_inner( + value = 'development', + name = 'Development', + status = 'active', ) + ], ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/EntitlementDocument.md b/docs/tools/sdk/python/Reference/V3/Models/EntitlementDocument.md new file mode 100644 index 000000000..e9a38d238 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/EntitlementDocument.md @@ -0,0 +1,95 @@ +--- +id: entitlement-document +title: EntitlementDocument +pagination_label: EntitlementDocument +sidebar_label: EntitlementDocument +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementDocument', 'EntitlementDocument'] +slug: /tools/sdk/python/v3/models/entitlement-document +tags: ['SDK', 'Software Development Kit', 'EntitlementDocument', 'EntitlementDocument'] +--- + +# EntitlementDocument + +Entitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the referenced object. | [required] +**name** | **str** | The human readable name of the referenced object. | [required] +**modified** | **datetime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional] +**synced** | **str** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**display_name** | **str** | Entitlement's display name. | [optional] +**source** | [**EntitlementDocumentAllOfSource**](entitlement-document-all-of-source) | | [optional] +**segments** | [**[]BaseSegment**](base-segment) | Segments with the entitlement. | [optional] +**segment_count** | **int** | Number of segments with the role. | [optional] +**requestable** | **bool** | Indicates whether the entitlement is requestable. | [optional] [default to False] +**cloud_governed** | **bool** | Indicates whether the entitlement is cloud governed. | [optional] [default to False] +**created** | **datetime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**privileged** | **bool** | Indicates whether the entitlement is privileged. | [optional] [default to False] +**tags** | **[]str** | Tags that have been applied to the object. | [optional] +**attribute** | **str** | Attribute information for the entitlement. | [optional] +**value** | **str** | Value of the entitlement. | [optional] +**source_schema_object_type** | **str** | Source schema object type of the entitlement. | [optional] +**var_schema** | **str** | Schema type of the entitlement. | [optional] +**hash** | **str** | Read-only calculated hash value of an entitlement. | [optional] +**attributes** | **map[string]object** | Attributes of the entitlement. | [optional] +**truncated_attributes** | **[]str** | Truncated attributes of the entitlement. | [optional] +**contains_data_access** | **bool** | Indicates whether the entitlement contains data access. | [optional] [default to False] +**manually_updated_fields** | [**EntitlementDocumentAllOfManuallyUpdatedFields**](entitlement-document-all-of-manually-updated-fields) | | [optional] +**permissions** | [**[]EntitlementDocumentAllOfPermissions**](entitlement-document-all-of-permissions) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.entitlement_document import EntitlementDocument + +entitlement_document = EntitlementDocument( +id='2c91808375d8e80a0175e1f88a575222', +name='john.doe', +modified='2018-06-25T20:22:28.104Z', +synced='', +display_name='Admin', +source=sailpoint.v3.models.entitlement_document_all_of_source.EntitlementDocument_allOf_source( + id = '2c91808b6e9e6fb8016eec1a2b6f7b5f', + name = 'ODS-HR-Employees', + type = 'SOURCE', ), +segments=[ + sailpoint.v3.models.base_segment.BaseSegment( + id = 'b009b6e3-b56d-41d9-8735-cb532ea0b017', + name = 'Test Segment', ) + ], +segment_count=1, +requestable=False, +cloud_governed=False, +created='2018-06-25T20:22:28.104Z', +privileged=False, +tags=[TAG_1, TAG_2], +attribute='groups', +value='1733ff75-441e-4327-9bfc-3ac445fd8cd1', +source_schema_object_type='group', +var_schema='group', +hash='c6fab95235584cca98a454a2f51e5683bc77d6a0', +attributes={ }, +truncated_attributes=[ + '' + ], +contains_data_access=True, +manually_updated_fields=sailpoint.v3.models.entitlement_document_all_of_manually_updated_fields.EntitlementDocument_allOf_manuallyUpdatedFields( + description = False, + display_name = False, ), +permissions=[ + sailpoint.v3.models.entitlement_document_all_of_permissions.EntitlementDocument_allOf_permissions( + target = 'SYS.GV_$TRANSACTION', + rights = [ + 'SELECT' + ], ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/EntitlementDocumentAllOfManuallyUpdatedFields.md b/docs/tools/sdk/python/Reference/V3/Models/EntitlementDocumentAllOfManuallyUpdatedFields.md new file mode 100644 index 000000000..35a2cfe5b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/EntitlementDocumentAllOfManuallyUpdatedFields.md @@ -0,0 +1,36 @@ +--- +id: entitlement-document-all-of-manually-updated-fields +title: EntitlementDocumentAllOfManuallyUpdatedFields +pagination_label: EntitlementDocumentAllOfManuallyUpdatedFields +sidebar_label: EntitlementDocumentAllOfManuallyUpdatedFields +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementDocumentAllOfManuallyUpdatedFields', 'EntitlementDocumentAllOfManuallyUpdatedFields'] +slug: /tools/sdk/python/v3/models/entitlement-document-all-of-manually-updated-fields +tags: ['SDK', 'Software Development Kit', 'EntitlementDocumentAllOfManuallyUpdatedFields', 'EntitlementDocumentAllOfManuallyUpdatedFields'] +--- + +# EntitlementDocumentAllOfManuallyUpdatedFields + +Indicates whether the entitlement's display name and/or description have been manually updated. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **bool** | | [optional] [default to False] +**display_name** | **bool** | | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v3.models.entitlement_document_all_of_manually_updated_fields import EntitlementDocumentAllOfManuallyUpdatedFields + +entitlement_document_all_of_manually_updated_fields = EntitlementDocumentAllOfManuallyUpdatedFields( +description=False, +display_name=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/EntitlementDocumentAllOfPermissions.md b/docs/tools/sdk/python/Reference/V3/Models/EntitlementDocumentAllOfPermissions.md new file mode 100644 index 000000000..112f15002 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/EntitlementDocumentAllOfPermissions.md @@ -0,0 +1,37 @@ +--- +id: entitlement-document-all-of-permissions +title: EntitlementDocumentAllOfPermissions +pagination_label: EntitlementDocumentAllOfPermissions +sidebar_label: EntitlementDocumentAllOfPermissions +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementDocumentAllOfPermissions', 'EntitlementDocumentAllOfPermissions'] +slug: /tools/sdk/python/v3/models/entitlement-document-all-of-permissions +tags: ['SDK', 'Software Development Kit', 'EntitlementDocumentAllOfPermissions', 'EntitlementDocumentAllOfPermissions'] +--- + +# EntitlementDocumentAllOfPermissions + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**target** | **str** | The target the permission would grants rights on. | [optional] +**rights** | **[]str** | All the rights (e.g. actions) that this permission allows on the target | [optional] +} + +## Example + +```python +from sailpoint.v3.models.entitlement_document_all_of_permissions import EntitlementDocumentAllOfPermissions + +entitlement_document_all_of_permissions = EntitlementDocumentAllOfPermissions( +target='SYS.GV_$TRANSACTION', +rights=[ + 'SELECT' + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/EntitlementDocumentAllOfSource.md b/docs/tools/sdk/python/Reference/V3/Models/EntitlementDocumentAllOfSource.md new file mode 100644 index 000000000..fd921d54c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/EntitlementDocumentAllOfSource.md @@ -0,0 +1,38 @@ +--- +id: entitlement-document-all-of-source +title: EntitlementDocumentAllOfSource +pagination_label: EntitlementDocumentAllOfSource +sidebar_label: EntitlementDocumentAllOfSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementDocumentAllOfSource', 'EntitlementDocumentAllOfSource'] +slug: /tools/sdk/python/v3/models/entitlement-document-all-of-source +tags: ['SDK', 'Software Development Kit', 'EntitlementDocumentAllOfSource', 'EntitlementDocumentAllOfSource'] +--- + +# EntitlementDocumentAllOfSource + +Entitlement's source. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of entitlement's source. | [optional] +**name** | **str** | Display name of entitlement's source. | [optional] +**type** | **str** | Type of object. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.entitlement_document_all_of_source import EntitlementDocumentAllOfSource + +entitlement_document_all_of_source = EntitlementDocumentAllOfSource( +id='2c91808b6e9e6fb8016eec1a2b6f7b5f', +name='ODS-HR-Employees', +type='SOURCE' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/EntitlementOwner.md b/docs/tools/sdk/python/Reference/V3/Models/EntitlementOwner.md new file mode 100644 index 000000000..80c6ebcea --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/EntitlementOwner.md @@ -0,0 +1,38 @@ +--- +id: entitlement-owner +title: EntitlementOwner +pagination_label: EntitlementOwner +sidebar_label: EntitlementOwner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementOwner', 'EntitlementOwner'] +slug: /tools/sdk/python/v3/models/entitlement-owner +tags: ['SDK', 'Software Development Kit', 'EntitlementOwner', 'EntitlementOwner'] +--- + +# EntitlementOwner + +The identity that owns the entitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The identity ID | [optional] +**type** | **Enum** [ 'IDENTITY' ] | The type of object | [optional] +**name** | **str** | The display name of the identity | [optional] +} + +## Example + +```python +from sailpoint.v3.models.entitlement_owner import EntitlementOwner + +entitlement_owner = EntitlementOwner( +id='2c9180827ca885d7017ca8ce28a000eb', +type='IDENTITY', +name='john.doe' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/EntitlementRef.md b/docs/tools/sdk/python/Reference/V3/Models/EntitlementRef.md new file mode 100644 index 000000000..2a805e6ac --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/EntitlementRef.md @@ -0,0 +1,38 @@ +--- +id: entitlement-ref +title: EntitlementRef +pagination_label: EntitlementRef +sidebar_label: EntitlementRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementRef', 'EntitlementRef'] +slug: /tools/sdk/python/v3/models/entitlement-ref +tags: ['SDK', 'Software Development Kit', 'EntitlementRef', 'EntitlementRef'] +--- + +# EntitlementRef + +Entitlement including a specific set of access. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ENTITLEMENT' ] | Entitlement's DTO type. | [optional] +**id** | **str** | Entitlement's ID. | [optional] +**name** | **str** | Entitlement's display name. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.entitlement_ref import EntitlementRef + +entitlement_ref = EntitlementRef( +type='ENTITLEMENT', +id='2c91809773dee32014e13e122092014e', +name='CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/EntitlementRef1.md b/docs/tools/sdk/python/Reference/V3/Models/EntitlementRef1.md new file mode 100644 index 000000000..d62f42c2d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/EntitlementRef1.md @@ -0,0 +1,38 @@ +--- +id: entitlement-ref1 +title: EntitlementRef1 +pagination_label: EntitlementRef1 +sidebar_label: EntitlementRef1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementRef1', 'EntitlementRef1'] +slug: /tools/sdk/python/v3/models/entitlement-ref1 +tags: ['SDK', 'Software Development Kit', 'EntitlementRef1', 'EntitlementRef1'] +--- + +# EntitlementRef1 + +Entitlement including a specific set of access. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ENTITLEMENT' ] | Entitlement's DTO type. | [optional] +**id** | **str** | Entitlement's ID. | [optional] +**name** | **str** | Entitlement's display name. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.entitlement_ref1 import EntitlementRef1 + +entitlement_ref1 = EntitlementRef1( +type='ENTITLEMENT', +id='2c91809773dee32014e13e122092014e', +name='CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/EntitlementRequestConfig.md b/docs/tools/sdk/python/Reference/V3/Models/EntitlementRequestConfig.md new file mode 100644 index 000000000..ed2ae3d13 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/EntitlementRequestConfig.md @@ -0,0 +1,39 @@ +--- +id: entitlement-request-config +title: EntitlementRequestConfig +pagination_label: EntitlementRequestConfig +sidebar_label: EntitlementRequestConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementRequestConfig', 'EntitlementRequestConfig'] +slug: /tools/sdk/python/v3/models/entitlement-request-config +tags: ['SDK', 'Software Development Kit', 'EntitlementRequestConfig', 'EntitlementRequestConfig'] +--- + +# EntitlementRequestConfig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**allow_entitlement_request** | **bool** | If this is true, entitlement requests are allowed. | [optional] [default to False] +**request_comments_required** | **bool** | If this is true, comments are required to submit entitlement requests. | [optional] [default to False] +**denied_comments_required** | **bool** | If this is true, comments are required to reject entitlement requests. | [optional] [default to False] +**grant_request_approval_schemes** | **str** | Approval schemes for granting entitlement request. This can be empty if no approval is needed. Multiple schemes must be comma-separated. The valid schemes are \"entitlementOwner\", \"sourceOwner\", \"manager\" and \"`workgroup:{id}`\". You can use multiple governance groups (workgroups). | [optional] [default to 'sourceOwner'] +} + +## Example + +```python +from sailpoint.v3.models.entitlement_request_config import EntitlementRequestConfig + +entitlement_request_config = EntitlementRequestConfig( +allow_entitlement_request=True, +request_comments_required=False, +denied_comments_required=False, +grant_request_approval_schemes='sourceOwner' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/EntitlementSource.md b/docs/tools/sdk/python/Reference/V3/Models/EntitlementSource.md new file mode 100644 index 000000000..1e11ed182 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/EntitlementSource.md @@ -0,0 +1,37 @@ +--- +id: entitlement-source +title: EntitlementSource +pagination_label: EntitlementSource +sidebar_label: EntitlementSource +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementSource', 'EntitlementSource'] +slug: /tools/sdk/python/v3/models/entitlement-source +tags: ['SDK', 'Software Development Kit', 'EntitlementSource', 'EntitlementSource'] +--- + +# EntitlementSource + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The source ID | [optional] +**type** | **str** | The source type, will always be \"SOURCE\" | [optional] +**name** | **str** | The source name | [optional] +} + +## Example + +```python +from sailpoint.v3.models.entitlement_source import EntitlementSource + +entitlement_source = EntitlementSource( +id='2c9180827ca885d7017ca8ce28a000eb', +type='SOURCE', +name='ODS-AD-Source' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/EntitlementSummary.md b/docs/tools/sdk/python/Reference/V3/Models/EntitlementSummary.md new file mode 100644 index 000000000..0dbd30964 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/EntitlementSummary.md @@ -0,0 +1,54 @@ +--- +id: entitlement-summary +title: EntitlementSummary +pagination_label: EntitlementSummary +sidebar_label: EntitlementSummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EntitlementSummary', 'EntitlementSummary'] +slug: /tools/sdk/python/v3/models/entitlement-summary +tags: ['SDK', 'Software Development Kit', 'EntitlementSummary', 'EntitlementSummary'] +--- + +# EntitlementSummary + +EntitlementReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the referenced object. | [optional] +**name** | **str** | The human readable name of the referenced object. | [optional] +**display_name** | **str** | | [optional] +**description** | **str** | Description of access item. | [optional] +**source** | [**Reference**](reference) | | [optional] +**type** | **str** | Type of the access item. | [optional] +**privileged** | **bool** | | [optional] +**attribute** | **str** | | [optional] +**value** | **str** | | [optional] +**standalone** | **bool** | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.entitlement_summary import EntitlementSummary + +entitlement_summary = EntitlementSummary( +id='2c91808568c529c60168cca6f90c1313', +name='John Doe', +display_name='John Q. Doe', +description='', +source=sailpoint.v3.models.reference.Reference( + id = '2c91808568c529c60168cca6f90c1313', + name = 'John Doe', ), +type='ENTITLEMENT', +privileged=False, +attribute='memberOf', +value='CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com', +standalone=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ErrorMessageDto.md b/docs/tools/sdk/python/Reference/V3/Models/ErrorMessageDto.md new file mode 100644 index 000000000..6ef3b403f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ErrorMessageDto.md @@ -0,0 +1,37 @@ +--- +id: error-message-dto +title: ErrorMessageDto +pagination_label: ErrorMessageDto +sidebar_label: ErrorMessageDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ErrorMessageDto', 'ErrorMessageDto'] +slug: /tools/sdk/python/v3/models/error-message-dto +tags: ['SDK', 'Software Development Kit', 'ErrorMessageDto', 'ErrorMessageDto'] +--- + +# ErrorMessageDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **str** | The locale for the message text, a BCP 47 language tag. | [optional] +**locale_origin** | [**LocaleOrigin**](locale-origin) | | [optional] +**text** | **str** | Actual text of the error message in the indicated locale. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.error_message_dto import ErrorMessageDto + +error_message_dto = ErrorMessageDto( +locale='en-US', +locale_origin='DEFAULT', +text='The request was syntactically correct but its content is semantically invalid.' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ErrorResponseDto.md b/docs/tools/sdk/python/Reference/V3/Models/ErrorResponseDto.md new file mode 100644 index 000000000..6e26448d4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ErrorResponseDto.md @@ -0,0 +1,49 @@ +--- +id: error-response-dto +title: ErrorResponseDto +pagination_label: ErrorResponseDto +sidebar_label: ErrorResponseDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ErrorResponseDto', 'ErrorResponseDto'] +slug: /tools/sdk/python/v3/models/error-response-dto +tags: ['SDK', 'Software Development Kit', 'ErrorResponseDto', 'ErrorResponseDto'] +--- + +# ErrorResponseDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detail_code** | **str** | Fine-grained error code providing more detail of the error. | [optional] +**tracking_id** | **str** | Unique tracking id for the error. | [optional] +**messages** | [**[]ErrorMessageDto**](error-message-dto) | Generic localized reason for error | [optional] +**causes** | [**[]ErrorMessageDto**](error-message-dto) | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [optional] +} + +## Example + +```python +from sailpoint.v3.models.error_response_dto import ErrorResponseDto + +error_response_dto = ErrorResponseDto( +detail_code='400.1 Bad Request Content', +tracking_id='e7eab60924f64aa284175b9fa3309599', +messages=[ + sailpoint.v3.models.error_message_dto.ErrorMessageDto( + locale = 'en-US', + locale_origin = 'DEFAULT', + text = 'The request was syntactically correct but its content is semantically invalid.', ) + ], +causes=[ + sailpoint.v3.models.error_message_dto.ErrorMessageDto( + locale = 'en-US', + locale_origin = 'DEFAULT', + text = 'The request was syntactically correct but its content is semantically invalid.', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Event.md b/docs/tools/sdk/python/Reference/V3/Models/Event.md new file mode 100644 index 000000000..0962634e8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Event.md @@ -0,0 +1,70 @@ +--- +id: event +title: Event +pagination_label: Event +sidebar_label: Event +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Event', 'Event'] +slug: /tools/sdk/python/v3/models/event +tags: ['SDK', 'Software Development Kit', 'Event', 'Event'] +--- + +# Event + +Event + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the entitlement. | [optional] +**name** | **str** | Name of the entitlement. | [optional] +**created** | **datetime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**synced** | **str** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**action** | **str** | Name of the event as it's displayed in audit reports. | [optional] +**type** | **str** | Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. | [optional] +**actor** | [**EventActor**](event-actor) | | [optional] +**target** | [**EventTarget**](event-target) | | [optional] +**stack** | **str** | The event's stack. | [optional] +**tracking_number** | **str** | ID of the group of events. | [optional] +**ip_address** | **str** | Target system's IP address. | [optional] +**details** | **str** | ID of event's details. | [optional] +**attributes** | **map[string]object** | Attributes involved in the event. | [optional] +**objects** | **[]str** | Objects the event is happening to. | [optional] +**operation** | **str** | Operation, or action, performed during the event. | [optional] +**status** | **str** | Event status. Refer to [Event Statuses](https://documentation.sailpoint.com/saas/help/search/index.html#event-statuses) for a list of event statuses and their meanings. | [optional] +**technical_name** | **str** | Event's normalized name. This normalized name always follows the pattern of 'objects_operation_status'. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.event import Event + +event = Event( +id='2c91808375d8e80a0175e1f88a575222', +name='Add Entitlement Passed', +created='2018-06-25T20:22:28.104Z', +synced='2018-06-25T20:22:28.104Z', +action='AddEntitlement', +type='ACCESS_ITEM', +actor=sailpoint.v3.models.event_actor.Event_actor( + name = 'System', ), +target=sailpoint.v3.models.event_target.Event_target( + name = 'Carol.Adams', ), +stack='tpe', +tracking_number='63f891e0735f4cc8bf1968144a1e7440', +ip_address='52.52.97.85', +details='73b65dfbed1842548c207432a18c84b0', +attributes={pod=stg03-useast1, org=acme, sourceName=SailPoint}, +objects=[ + 'AUTHENTICATION' + ], +operation='ADD', +status='PASSED', +technical_name='ENTITLEMENT_ADD_PASSED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/EventActor.md b/docs/tools/sdk/python/Reference/V3/Models/EventActor.md new file mode 100644 index 000000000..9f21d7943 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/EventActor.md @@ -0,0 +1,33 @@ +--- +id: event-actor +title: EventActor +pagination_label: EventActor +sidebar_label: EventActor +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EventActor', 'EventActor'] +slug: /tools/sdk/python/v3/models/event-actor +tags: ['SDK', 'Software Development Kit', 'EventActor', 'EventActor'] +--- + +# EventActor + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the actor that generated the event. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.event_actor import EventActor + +event_actor = EventActor( +name='System' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/EventAttributes.md b/docs/tools/sdk/python/Reference/V3/Models/EventAttributes.md new file mode 100644 index 000000000..526b9bab6 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/EventAttributes.md @@ -0,0 +1,42 @@ +--- +id: event-attributes +title: EventAttributes +pagination_label: EventAttributes +sidebar_label: EventAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EventAttributes', 'EventAttributes'] +slug: /tools/sdk/python/v3/models/event-attributes +tags: ['SDK', 'Software Development Kit', 'EventAttributes', 'EventAttributes'] +--- + +# EventAttributes + +Attributes related to an IdentityNow ETS event + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the trigger | [required] +**filter_** | **str** | JSON path expression that will limit which events the trigger will fire on | [optional] +**description** | **str** | Description of the event trigger | [optional] +**attribute_to_filter** | **str** | The attribute to filter on | [optional] +**form_definition_id** | **str** | Form definition's unique identifier. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.event_attributes import EventAttributes + +event_attributes = EventAttributes( +id='idn:identity-attributes-changed', +filter_='$.changes[?(@.attribute == 'manager')]', +description='Triggered when an identity's manager attribute changes', +attribute_to_filter='LifecycleState', +form_definition_id='Admin_Access_Request_Form' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/EventDocument.md b/docs/tools/sdk/python/Reference/V3/Models/EventDocument.md new file mode 100644 index 000000000..21fc2569d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/EventDocument.md @@ -0,0 +1,70 @@ +--- +id: event-document +title: EventDocument +pagination_label: EventDocument +sidebar_label: EventDocument +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EventDocument', 'EventDocument'] +slug: /tools/sdk/python/v3/models/event-document +tags: ['SDK', 'Software Development Kit', 'EventDocument', 'EventDocument'] +--- + +# EventDocument + +Event + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the entitlement. | [optional] +**name** | **str** | Name of the entitlement. | [optional] +**created** | **datetime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**synced** | **str** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**action** | **str** | Name of the event as it's displayed in audit reports. | [optional] +**type** | **str** | Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. | [optional] +**actor** | [**EventActor**](event-actor) | | [optional] +**target** | [**EventTarget**](event-target) | | [optional] +**stack** | **str** | The event's stack. | [optional] +**tracking_number** | **str** | ID of the group of events. | [optional] +**ip_address** | **str** | Target system's IP address. | [optional] +**details** | **str** | ID of event's details. | [optional] +**attributes** | **map[string]object** | Attributes involved in the event. | [optional] +**objects** | **[]str** | Objects the event is happening to. | [optional] +**operation** | **str** | Operation, or action, performed during the event. | [optional] +**status** | **str** | Event status. Refer to [Event Statuses](https://documentation.sailpoint.com/saas/help/search/index.html#event-statuses) for a list of event statuses and their meanings. | [optional] +**technical_name** | **str** | Event's normalized name. This normalized name always follows the pattern of 'objects_operation_status'. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.event_document import EventDocument + +event_document = EventDocument( +id='2c91808375d8e80a0175e1f88a575222', +name='Add Entitlement Passed', +created='2018-06-25T20:22:28.104Z', +synced='2018-06-25T20:22:28.104Z', +action='AddEntitlement', +type='ACCESS_ITEM', +actor=sailpoint.v3.models.event_actor.Event_actor( + name = 'System', ), +target=sailpoint.v3.models.event_target.Event_target( + name = 'Carol.Adams', ), +stack='tpe', +tracking_number='63f891e0735f4cc8bf1968144a1e7440', +ip_address='52.52.97.85', +details='73b65dfbed1842548c207432a18c84b0', +attributes={pod=stg03-useast1, org=acme, sourceName=SailPoint}, +objects=[ + 'AUTHENTICATION' + ], +operation='ADD', +status='PASSED', +technical_name='ENTITLEMENT_ADD_PASSED' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/EventTarget.md b/docs/tools/sdk/python/Reference/V3/Models/EventTarget.md new file mode 100644 index 000000000..856e76541 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/EventTarget.md @@ -0,0 +1,33 @@ +--- +id: event-target +title: EventTarget +pagination_label: EventTarget +sidebar_label: EventTarget +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'EventTarget', 'EventTarget'] +slug: /tools/sdk/python/v3/models/event-target +tags: ['SDK', 'Software Development Kit', 'EventTarget', 'EventTarget'] +--- + +# EventTarget + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the target, or recipient, of the event. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.event_target import EventTarget + +event_target = EventTarget( +name='Carol.Adams' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ExceptionAccessCriteria.md b/docs/tools/sdk/python/Reference/V3/Models/ExceptionAccessCriteria.md new file mode 100644 index 000000000..44c3004c2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ExceptionAccessCriteria.md @@ -0,0 +1,37 @@ +--- +id: exception-access-criteria +title: ExceptionAccessCriteria +pagination_label: ExceptionAccessCriteria +sidebar_label: ExceptionAccessCriteria +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ExceptionAccessCriteria', 'ExceptionAccessCriteria'] +slug: /tools/sdk/python/v3/models/exception-access-criteria +tags: ['SDK', 'Software Development Kit', 'ExceptionAccessCriteria', 'ExceptionAccessCriteria'] +--- + +# ExceptionAccessCriteria + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**left_criteria** | [**ExceptionCriteria**](exception-criteria) | | [optional] +**right_criteria** | [**ExceptionCriteria**](exception-criteria) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.exception_access_criteria import ExceptionAccessCriteria + +exception_access_criteria = ExceptionAccessCriteria( +left_criteria=sailpoint.v3.models.exception_criteria.ExceptionCriteria( + criteria_list = [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, existing=true}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, existing=false}], ), +right_criteria=sailpoint.v3.models.exception_criteria.ExceptionCriteria( + criteria_list = [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, existing=true}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, existing=false}], ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ExceptionCriteria.md b/docs/tools/sdk/python/Reference/V3/Models/ExceptionCriteria.md new file mode 100644 index 000000000..c6ea1b94e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ExceptionCriteria.md @@ -0,0 +1,33 @@ +--- +id: exception-criteria +title: ExceptionCriteria +pagination_label: ExceptionCriteria +sidebar_label: ExceptionCriteria +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ExceptionCriteria', 'ExceptionCriteria'] +slug: /tools/sdk/python/v3/models/exception-criteria +tags: ['SDK', 'Software Development Kit', 'ExceptionCriteria', 'ExceptionCriteria'] +--- + +# ExceptionCriteria + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**criteria_list** | [**[]ExceptionCriteriaCriteriaListInner**](exception-criteria-criteria-list-inner) | List of exception criteria. There is a min of 1 and max of 50 items in the list. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.exception_criteria import ExceptionCriteria + +exception_criteria = ExceptionCriteria( +criteria_list=[{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, existing=true}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, existing=false}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ExceptionCriteriaAccess.md b/docs/tools/sdk/python/Reference/V3/Models/ExceptionCriteriaAccess.md new file mode 100644 index 000000000..a48b36f82 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ExceptionCriteriaAccess.md @@ -0,0 +1,40 @@ +--- +id: exception-criteria-access +title: ExceptionCriteriaAccess +pagination_label: ExceptionCriteriaAccess +sidebar_label: ExceptionCriteriaAccess +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ExceptionCriteriaAccess', 'ExceptionCriteriaAccess'] +slug: /tools/sdk/python/v3/models/exception-criteria-access +tags: ['SDK', 'Software Development Kit', 'ExceptionCriteriaAccess', 'ExceptionCriteriaAccess'] +--- + +# ExceptionCriteriaAccess + +Access reference with addition of boolean existing flag to indicate whether the access was extant + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**DtoType**](dto-type) | | [optional] +**id** | **str** | ID of the object to which this reference applies | [optional] +**name** | **str** | Human-readable display name of the object to which this reference applies | [optional] +**existing** | **bool** | Whether the subject identity already had that access or not | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v3.models.exception_criteria_access import ExceptionCriteriaAccess + +exception_criteria_access = ExceptionCriteriaAccess( +type='IDENTITY', +id='2c91808568c529c60168cca6f90c1313', +name='CN=HelpDesk,OU=test,OU=test-service,DC=TestAD,DC=local', +existing=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ExceptionCriteriaCriteriaListInner.md b/docs/tools/sdk/python/Reference/V3/Models/ExceptionCriteriaCriteriaListInner.md new file mode 100644 index 000000000..640773063 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ExceptionCriteriaCriteriaListInner.md @@ -0,0 +1,40 @@ +--- +id: exception-criteria-criteria-list-inner +title: ExceptionCriteriaCriteriaListInner +pagination_label: ExceptionCriteriaCriteriaListInner +sidebar_label: ExceptionCriteriaCriteriaListInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ExceptionCriteriaCriteriaListInner', 'ExceptionCriteriaCriteriaListInner'] +slug: /tools/sdk/python/v3/models/exception-criteria-criteria-list-inner +tags: ['SDK', 'Software Development Kit', 'ExceptionCriteriaCriteriaListInner', 'ExceptionCriteriaCriteriaListInner'] +--- + +# ExceptionCriteriaCriteriaListInner + +The types of objects supported for SOD violations + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ENTITLEMENT' ] | The type of object that is referenced | [optional] +**id** | **str** | ID of the object to which this reference applies | [optional] +**name** | **str** | Human-readable display name of the object to which this reference applies | [optional] +**existing** | **bool** | Whether the subject identity already had that access or not | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v3.models.exception_criteria_criteria_list_inner import ExceptionCriteriaCriteriaListInner + +exception_criteria_criteria_list_inner = ExceptionCriteriaCriteriaListInner( +type=ENTITLEMENT, +id='2c91808568c529c60168cca6f90c1313', +name='CN=HelpDesk,OU=test,OU=test-service,DC=TestAD,DC=local', +existing=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ExecutionStatus.md b/docs/tools/sdk/python/Reference/V3/Models/ExecutionStatus.md new file mode 100644 index 000000000..d5e84a1d8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ExecutionStatus.md @@ -0,0 +1,27 @@ +--- +id: execution-status +title: ExecutionStatus +pagination_label: ExecutionStatus +sidebar_label: ExecutionStatus +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ExecutionStatus', 'ExecutionStatus'] +slug: /tools/sdk/python/v3/models/execution-status +tags: ['SDK', 'Software Development Kit', 'ExecutionStatus', 'ExecutionStatus'] +--- + +# ExecutionStatus + +The current state of execution. + +## Enum + +* `EXECUTING` (value: `'EXECUTING'`) + +* `VERIFYING` (value: `'VERIFYING'`) + +* `TERMINATED` (value: `'TERMINATED'`) + +* `COMPLETED` (value: `'COMPLETED'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ExpansionItem.md b/docs/tools/sdk/python/Reference/V3/Models/ExpansionItem.md new file mode 100644 index 000000000..fd1ad71c0 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ExpansionItem.md @@ -0,0 +1,48 @@ +--- +id: expansion-item +title: ExpansionItem +pagination_label: ExpansionItem +sidebar_label: ExpansionItem +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ExpansionItem', 'ExpansionItem'] +slug: /tools/sdk/python/v3/models/expansion-item +tags: ['SDK', 'Software Development Kit', 'ExpansionItem', 'ExpansionItem'] +--- + +# ExpansionItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_id** | **str** | The ID of the account | [optional] +**cause** | **str** | Cause of the expansion item. | [optional] +**name** | **str** | The name of the item | [optional] +**attribute_request** | [**AttributeRequest**](attribute-request) | | [optional] +**source** | [**AccountSource**](account-source) | | [optional] +**id** | **str** | ID of the expansion item | [optional] +**state** | **str** | State of the expansion item | [optional] +} + +## Example + +```python +from sailpoint.v3.models.expansion_item import ExpansionItem + +expansion_item = ExpansionItem( +account_id='2c91808981f58ea601821c3e93482e6f', +cause='Role', +name='smartsheet-role', +attribute_request=sailpoint.v3.models.attribute_request.AttributeRequest( + name = 'groups', + op = 'Add', + value = null, ), +source=, +id='ac2887ffe0e7435a8c18c73f7ae94c7b', +state='EXECUTING' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Expression.md b/docs/tools/sdk/python/Reference/V3/Models/Expression.md new file mode 100644 index 000000000..d8dada323 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Expression.md @@ -0,0 +1,40 @@ +--- +id: expression +title: Expression +pagination_label: Expression +sidebar_label: Expression +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Expression', 'Expression'] +slug: /tools/sdk/python/v3/models/expression +tags: ['SDK', 'Software Development Kit', 'Expression', 'Expression'] +--- + +# Expression + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operator** | **Enum** [ 'AND', 'EQUALS' ] | Operator for the expression | [optional] +**attribute** | **str** | Name for the attribute | [optional] +**value** | [**Value**](value) | | [optional] +**children** | [**[]ExpressionChildrenInner**](expression-children-inner) | List of expressions | [optional] +} + +## Example + +```python +from sailpoint.v3.models.expression import Expression + +expression = Expression( +operator='EQUALS', +attribute='location', +value=sailpoint.v3.models.value.Value( + type = 'STRING', ), +children=[] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ExpressionChildrenInner.md b/docs/tools/sdk/python/Reference/V3/Models/ExpressionChildrenInner.md new file mode 100644 index 000000000..883658cd3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ExpressionChildrenInner.md @@ -0,0 +1,40 @@ +--- +id: expression-children-inner +title: ExpressionChildrenInner +pagination_label: ExpressionChildrenInner +sidebar_label: ExpressionChildrenInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ExpressionChildrenInner', 'ExpressionChildrenInner'] +slug: /tools/sdk/python/v3/models/expression-children-inner +tags: ['SDK', 'Software Development Kit', 'ExpressionChildrenInner', 'ExpressionChildrenInner'] +--- + +# ExpressionChildrenInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operator** | **Enum** [ 'AND', 'EQUALS' ] | Operator for the expression | [optional] +**attribute** | **str** | Name for the attribute | [optional] +**value** | [**Value**](value) | | [optional] +**children** | **str** | There cannot be anymore nested children. This will always be null. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.expression_children_inner import ExpressionChildrenInner + +expression_children_inner = ExpressionChildrenInner( +operator='EQUALS', +attribute='location', +value=sailpoint.v3.models.value.Value( + type = 'STRING', ), +children='' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ExternalAttributes.md b/docs/tools/sdk/python/Reference/V3/Models/ExternalAttributes.md new file mode 100644 index 000000000..b91f2a626 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ExternalAttributes.md @@ -0,0 +1,40 @@ +--- +id: external-attributes +title: ExternalAttributes +pagination_label: ExternalAttributes +sidebar_label: ExternalAttributes +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ExternalAttributes', 'ExternalAttributes'] +slug: /tools/sdk/python/v3/models/external-attributes +tags: ['SDK', 'Software Development Kit', 'ExternalAttributes', 'ExternalAttributes'] +--- + +# ExternalAttributes + +Attributes related to an external trigger + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | A unique name for the external trigger | [optional] +**description** | **str** | Additional context about the external trigger | [optional] +**client_id** | **str** | OAuth Client ID to authenticate with this trigger | [optional] +**url** | **str** | URL to invoke this workflow | [optional] +} + +## Example + +```python +from sailpoint.v3.models.external_attributes import ExternalAttributes + +external_attributes = ExternalAttributes( +name='search-and-notify', +description='Run a search and notify the results', +client_id='87e239b2-b85b-4bde-b9a7-55bf304ddcdc', +url='https://tenant.api.identitynow.com/beta/workflows/execute/external/c79e0079-562c-4df5-aa73-60a9e25c916d' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/FederationProtocolDetails.md b/docs/tools/sdk/python/Reference/V3/Models/FederationProtocolDetails.md new file mode 100644 index 000000000..2d0aac04a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/FederationProtocolDetails.md @@ -0,0 +1,35 @@ +--- +id: federation-protocol-details +title: FederationProtocolDetails +pagination_label: FederationProtocolDetails +sidebar_label: FederationProtocolDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FederationProtocolDetails', 'FederationProtocolDetails'] +slug: /tools/sdk/python/v3/models/federation-protocol-details +tags: ['SDK', 'Software Development Kit', 'FederationProtocolDetails', 'FederationProtocolDetails'] +--- + +# FederationProtocolDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**role** | **Enum** [ 'SAML_IDP', 'SAML_SP' ] | Federation protocol role | [optional] +**entity_id** | **str** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +} + +## Example + +```python +from sailpoint.v3.models.federation_protocol_details import FederationProtocolDetails + +federation_protocol_details = FederationProtocolDetails( +role='SAML_IDP', +entity_id='http://www.okta.com/exkdaruy8Ln5Ry7C54x6' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/FieldDetailsDto.md b/docs/tools/sdk/python/Reference/V3/Models/FieldDetailsDto.md new file mode 100644 index 000000000..2e559631f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/FieldDetailsDto.md @@ -0,0 +1,43 @@ +--- +id: field-details-dto +title: FieldDetailsDto +pagination_label: FieldDetailsDto +sidebar_label: FieldDetailsDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FieldDetailsDto', 'FieldDetailsDto'] +slug: /tools/sdk/python/v3/models/field-details-dto +tags: ['SDK', 'Software Development Kit', 'FieldDetailsDto', 'FieldDetailsDto'] +--- + +# FieldDetailsDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the attribute. | [optional] +**transform** | **object** | The transform to apply to the field | [optional] +**attributes** | **object** | Attributes required for the transform | [optional] +**is_required** | **bool** | Flag indicating whether or not the attribute is required. | [optional] [readonly] [default to False] +**type** | **str** | The type of the attribute. | [optional] +**is_multi_valued** | **bool** | Flag indicating whether or not the attribute is multi-valued. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v3.models.field_details_dto import FieldDetailsDto + +field_details_dto = FieldDetailsDto( +name='userName', +transform={type=rule, attributes={name=Create Unique LDAP Attribute}}, +attributes={template=${firstname}.${lastname}${uniqueCounter}, cloudMaxUniqueChecks=50, cloudMaxSize=20, cloudRequired=true}, +is_required=False, +type='string', +is_multi_valued=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Filter.md b/docs/tools/sdk/python/Reference/V3/Models/Filter.md new file mode 100644 index 000000000..7d40ef51b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/Filter.md @@ -0,0 +1,47 @@ +--- +id: filter +title: Filter +pagination_label: Filter +sidebar_label: Filter +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'Filter', 'Filter'] +slug: /tools/sdk/python/v3/models/filter +tags: ['SDK', 'Software Development Kit', 'Filter', 'Filter'] +--- + +# Filter + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**FilterType**](filter-type) | | [optional] +**range** | [**Range**](range) | | [optional] +**terms** | **[]str** | The terms to be filtered. | [optional] +**exclude** | **bool** | Indicates if the filter excludes results. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v3.models.filter import Filter + +filter = Filter( +type='RANGE', +range=sailpoint.v3.models.range.Range( + lower = sailpoint.v3.models.bound.Bound( + value = '1', + inclusive = False, ), + upper = sailpoint.v3.models.bound.Bound( + value = '1', + inclusive = False, ), ), +terms=[ + 'account_count' + ], +exclude=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/FilterAggregation.md b/docs/tools/sdk/python/Reference/V3/Models/FilterAggregation.md new file mode 100644 index 000000000..d8174bb50 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/FilterAggregation.md @@ -0,0 +1,40 @@ +--- +id: filter-aggregation +title: FilterAggregation +pagination_label: FilterAggregation +sidebar_label: FilterAggregation +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FilterAggregation', 'FilterAggregation'] +slug: /tools/sdk/python/v3/models/filter-aggregation +tags: ['SDK', 'Software Development Kit', 'FilterAggregation', 'FilterAggregation'] +--- + +# FilterAggregation + +An additional filter to constrain the results of the search query. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the filter aggregate to be included in the result. | [required] +**type** | [**SearchFilterType**](search-filter-type) | | [optional] [default to SearchFilterType.TERM] +**var_field** | **str** | The search field to apply the filter to. Prefix the field name with '@' to reference a nested object. | [required] +**value** | **str** | The value to filter on. | [required] +} + +## Example + +```python +from sailpoint.v3.models.filter_aggregation import FilterAggregation + +filter_aggregation = FilterAggregation( +name='Entitlements', +type='TERM', +var_field='access.type', +value='ENTITLEMENT' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/FilterType.md b/docs/tools/sdk/python/Reference/V3/Models/FilterType.md new file mode 100644 index 000000000..5963d1f88 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/FilterType.md @@ -0,0 +1,25 @@ +--- +id: filter-type +title: FilterType +pagination_label: FilterType +sidebar_label: FilterType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FilterType', 'FilterType'] +slug: /tools/sdk/python/v3/models/filter-type +tags: ['SDK', 'Software Development Kit', 'FilterType', 'FilterType'] +--- + +# FilterType + +Enum representing the currently supported filter types. Additional values may be added in the future without notice. + +## Enum + +* `EXISTS` (value: `'EXISTS'`) + +* `RANGE` (value: `'RANGE'`) + +* `TERMS` (value: `'TERMS'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/FormDetails.md b/docs/tools/sdk/python/Reference/V3/Models/FormDetails.md new file mode 100644 index 000000000..aea6f6a20 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/FormDetails.md @@ -0,0 +1,45 @@ +--- +id: form-details +title: FormDetails +pagination_label: FormDetails +sidebar_label: FormDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormDetails', 'FormDetails'] +slug: /tools/sdk/python/v3/models/form-details +tags: ['SDK', 'Software Development Kit', 'FormDetails', 'FormDetails'] +--- + +# FormDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the form | [optional] +**name** | **str** | Name of the form | [optional] +**title** | **str** | The form title | [optional] +**subtitle** | **str** | The form subtitle. | [optional] +**target_user** | **str** | The name of the user that should be shown this form | [optional] +**sections** | [**[]SectionDetails**](section-details) | Sections of the form | [optional] +} + +## Example + +```python +from sailpoint.v3.models.form_details import FormDetails + +form_details = FormDetails( +id='2c9180835d2e5168015d32f890ca1581', +name='AccountSelection Form', +title='Account Selection for John.Doe', +subtitle='Please select from the following', +target_user='Jane.Doe', +sections=[ + sailpoint.v3.models.section_details.SectionDetails() + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/FormItemDetails.md b/docs/tools/sdk/python/Reference/V3/Models/FormItemDetails.md new file mode 100644 index 000000000..41654b186 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/FormItemDetails.md @@ -0,0 +1,33 @@ +--- +id: form-item-details +title: FormItemDetails +pagination_label: FormItemDetails +sidebar_label: FormItemDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FormItemDetails', 'FormItemDetails'] +slug: /tools/sdk/python/v3/models/form-item-details +tags: ['SDK', 'Software Development Kit', 'FormItemDetails', 'FormItemDetails'] +--- + +# FormItemDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the FormItem | [optional] +} + +## Example + +```python +from sailpoint.v3.models.form_item_details import FormItemDetails + +form_item_details = FormItemDetails( +name='Field1' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/ForwardApprovalDto.md b/docs/tools/sdk/python/Reference/V3/Models/ForwardApprovalDto.md new file mode 100644 index 000000000..21f2682ef --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/ForwardApprovalDto.md @@ -0,0 +1,35 @@ +--- +id: forward-approval-dto +title: ForwardApprovalDto +pagination_label: ForwardApprovalDto +sidebar_label: ForwardApprovalDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ForwardApprovalDto', 'ForwardApprovalDto'] +slug: /tools/sdk/python/v3/models/forward-approval-dto +tags: ['SDK', 'Software Development Kit', 'ForwardApprovalDto', 'ForwardApprovalDto'] +--- + +# ForwardApprovalDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**new_owner_id** | **str** | The Id of the new owner | [required] +**comment** | **str** | The comment provided by the forwarder | [required] +} + +## Example + +```python +from sailpoint.v3.models.forward_approval_dto import ForwardApprovalDto + +forward_approval_dto = ForwardApprovalDto( +new_owner_id='2c91808568c529c60168cca6f90c1314', +comment='2c91808568c529c60168cca6f90c1313' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/FullDiscoveredApplications.md b/docs/tools/sdk/python/Reference/V3/Models/FullDiscoveredApplications.md new file mode 100644 index 000000000..3163f9f78 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/FullDiscoveredApplications.md @@ -0,0 +1,52 @@ +--- +id: full-discovered-applications +title: FullDiscoveredApplications +pagination_label: FullDiscoveredApplications +sidebar_label: FullDiscoveredApplications +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FullDiscoveredApplications', 'FullDiscoveredApplications'] +slug: /tools/sdk/python/v3/models/full-discovered-applications +tags: ['SDK', 'Software Development Kit', 'FullDiscoveredApplications', 'FullDiscoveredApplications'] +--- + +# FullDiscoveredApplications + +Discovered applications with their respective associated sources + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Unique identifier for the discovered application. | [optional] +**name** | **str** | Name of the discovered application. | [optional] +**discovery_source** | **str** | Source from which the application was discovered. | [optional] +**discovered_vendor** | **str** | The vendor associated with the discovered application. | [optional] +**description** | **str** | A brief description of the discovered application. | [optional] +**recommended_connectors** | **[]str** | List of recommended connectors for the application. | [optional] +**discovered_at** | **datetime** | The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. | [optional] +**created_at** | **datetime** | The timestamp when the application was first discovered, in ISO 8601 format. | [optional] +**status** | **str** | The status of an application within the discovery source. By default this field is set to \"ACTIVE\" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to \"INACTIVE\". | [optional] +**associated_sources** | **[]str** | List of associated sources related to this discovered application. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.full_discovered_applications import FullDiscoveredApplications + +full_discovered_applications = FullDiscoveredApplications( +id='', +name='ExampleApp', +discovery_source='csv', +discovered_vendor='ExampleVendor', +description='An application for managing examples.', +recommended_connectors=[ConnectorA, ConnectorB], +discovered_at='2023-01-01T12:00Z', +created_at='2023-01-01T12:00Z', +status='ACTIVE', +associated_sources=[e0cc5d7d-bf7f-4f81-b2af-8885b09d9923, a0303682-5e4a-44f7-bdc2-6ce6112549c1] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/GetActiveCampaigns200ResponseInner.md b/docs/tools/sdk/python/Reference/V3/Models/GetActiveCampaigns200ResponseInner.md new file mode 100644 index 000000000..d956fb57f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/GetActiveCampaigns200ResponseInner.md @@ -0,0 +1,122 @@ +--- +id: get-active-campaigns200-response-inner +title: GetActiveCampaigns200ResponseInner +pagination_label: GetActiveCampaigns200ResponseInner +sidebar_label: GetActiveCampaigns200ResponseInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'GetActiveCampaigns200ResponseInner', 'GetActiveCampaigns200ResponseInner'] +slug: /tools/sdk/python/v3/models/get-active-campaigns200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetActiveCampaigns200ResponseInner', 'GetActiveCampaigns200ResponseInner'] +--- + +# GetActiveCampaigns200ResponseInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the campaign | [optional] [readonly] +**name** | **str** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**description** | **str** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**deadline** | **datetime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] +**type** | **Enum** [ 'MANAGER', 'SOURCE_OWNER', 'SEARCH', 'ROLE_COMPOSITION', 'MACHINE_ACCOUNT' ] | The type of campaign. Could be extended in the future. | [required] +**email_notification_enabled** | **bool** | Enables email notification for this campaign | [optional] [default to False] +**auto_revoke_allowed** | **bool** | Allows auto revoke for this campaign | [optional] [default to False] +**recommendations_enabled** | **bool** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to False] +**status** | **Enum** [ 'PENDING', 'STAGED', 'CANCELING', 'ACTIVATING', 'ACTIVE', 'COMPLETING', 'COMPLETED', 'ERROR', 'ARCHIVED' ] | The campaign's current status. | [optional] [readonly] +**correlated_status** | **Enum** [ 'CORRELATED', 'UNCORRELATED' ] | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] +**created** | **datetime** | Created time of the campaign | [optional] [readonly] +**total_certifications** | **int** | The total number of certifications in this campaign. | [optional] [readonly] +**completed_certifications** | **int** | The number of completed certifications in this campaign. | [optional] [readonly] +**alerts** | [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] +**modified** | **datetime** | Modified time of the campaign | [optional] [readonly] +**filter** | [**CampaignAllOfFilter**](campaign-all-of-filter) | | [optional] +**sunset_comments_required** | **bool** | Determines if comments on sunset date changes are required. | [optional] [default to True] +**source_owner_campaign_info** | [**CampaignAllOfSourceOwnerCampaignInfo**](campaign-all-of-source-owner-campaign-info) | | [optional] +**search_campaign_info** | [**CampaignAllOfSearchCampaignInfo**](campaign-all-of-search-campaign-info) | | [optional] +**role_composition_campaign_info** | [**CampaignAllOfRoleCompositionCampaignInfo**](campaign-all-of-role-composition-campaign-info) | | [optional] +**machine_account_campaign_info** | [**CampaignAllOfMachineAccountCampaignInfo**](campaign-all-of-machine-account-campaign-info) | | [optional] +**sources_with_orphan_entitlements** | [**[]CampaignAllOfSourcesWithOrphanEntitlements**](campaign-all-of-sources-with-orphan-entitlements) | A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [optional] [readonly] +**mandatory_comment_requirement** | **Enum** [ 'ALL_DECISIONS', 'REVOKE_ONLY_DECISIONS', 'NO_DECISIONS' ] | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner + +get_active_campaigns200_response_inner = GetActiveCampaigns200ResponseInner( +id='2c9079b270a266a60170a2779fcb0007', +name='Manager Campaign', +description='Everyone needs to be reviewed by their manager', +deadline='2020-03-15T10:00:01.456Z', +type='MANAGER', +email_notification_enabled=False, +auto_revoke_allowed=False, +recommendations_enabled=True, +status='ACTIVE', +correlated_status='CORRELATED', +created='2020-03-03T22:15:13.611Z', +total_certifications=100, +completed_certifications=10, +alerts=[ + sailpoint.v3.models.campaign_alert.CampaignAlert( + level = 'ERROR', + localizations = [ + sailpoint.v3.models.error_message_dto.ErrorMessageDto( + locale = 'en-US', + locale_origin = 'DEFAULT', + text = 'The request was syntactically correct but its content is semantically invalid.', ) + ], ) + ], +modified='2020-03-03T22:20:12.674Z', +filter=sailpoint.v3.models.campaign_all_of_filter.Campaign_allOf_filter( + id = '0fbe863c063c4c88a35fd7f17e8a3df5', + type = 'CAMPAIGN_FILTER', + name = 'Test Filter', ), +sunset_comments_required=True, +source_owner_campaign_info=sailpoint.v3.models.campaign_all_of_source_owner_campaign_info.Campaign_allOf_sourceOwnerCampaignInfo( + source_ids = [0fbe863c063c4c88a35fd7f17e8a3df5], ), +search_campaign_info=sailpoint.v3.models.campaign_all_of_search_campaign_info.Campaign_allOf_searchCampaignInfo( + type = 'ACCESS', + description = 'Search Campaign description', + reviewer = sailpoint.v3.models.campaign_all_of_search_campaign_info_reviewer.Campaign_allOf_searchCampaignInfo_reviewer( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), + query = 'Search Campaign query description', + identity_ids = [0fbe863c063c4c88a35fd7f17e8a3df5], + access_constraints = [ + sailpoint.v3.models.access_constraint.AccessConstraint( + type = 'ENTITLEMENT', + ids = [2c90ad2a70ace7d50170acf22ca90010], + operator = 'SELECTED', ) + ], ), +role_composition_campaign_info=sailpoint.v3.models.campaign_all_of_role_composition_campaign_info.Campaign_allOf_roleCompositionCampaignInfo( + reviewer = sailpoint.v3.models.campaign_all_of_search_campaign_info_reviewer.Campaign_allOf_searchCampaignInfo_reviewer( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), + role_ids = [2c90ad2a70ace7d50170acf22ca90010], + remediator_ref = sailpoint.v3.models.campaign_all_of_role_composition_campaign_info_remediator_ref.Campaign_allOf_roleCompositionCampaignInfo_remediatorRef( + type = 'IDENTITY', + id = '2c90ad2a70ace7d50170acf22ca90010', + name = 'Role Admin', ), + query = 'Search Query', + description = 'Role Composition Description', ), +machine_account_campaign_info=sailpoint.v3.models.campaign_all_of_machine_account_campaign_info.Campaign_allOf_machineAccountCampaignInfo( + source_ids = [0fbe863c063c4c88a35fd7f17e8a3df5], + reviewer_type = 'ACCOUNT_OWNER', ), +sources_with_orphan_entitlements=[ + sailpoint.v3.models.campaign_all_of_sources_with_orphan_entitlements.Campaign_allOf_sourcesWithOrphanEntitlements( + id = '2c90ad2a70ace7d50170acf22ca90010', + type = 'SOURCE', + name = 'Source with orphan entitlements', ) + ], +mandatory_comment_requirement='NO_DECISIONS' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/GetDiscoveredApplications200ResponseInner.md b/docs/tools/sdk/python/Reference/V3/Models/GetDiscoveredApplications200ResponseInner.md new file mode 100644 index 000000000..b9fffdee4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/GetDiscoveredApplications200ResponseInner.md @@ -0,0 +1,51 @@ +--- +id: get-discovered-applications200-response-inner +title: GetDiscoveredApplications200ResponseInner +pagination_label: GetDiscoveredApplications200ResponseInner +sidebar_label: GetDiscoveredApplications200ResponseInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'GetDiscoveredApplications200ResponseInner', 'GetDiscoveredApplications200ResponseInner'] +slug: /tools/sdk/python/v3/models/get-discovered-applications200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetDiscoveredApplications200ResponseInner', 'GetDiscoveredApplications200ResponseInner'] +--- + +# GetDiscoveredApplications200ResponseInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Unique identifier for the discovered application. | [optional] +**name** | **str** | Name of the discovered application. | [optional] +**discovery_source** | **str** | Source from which the application was discovered. | [optional] +**discovered_vendor** | **str** | The vendor associated with the discovered application. | [optional] +**description** | **str** | A brief description of the discovered application. | [optional] +**recommended_connectors** | **[]str** | List of recommended connectors for the application. | [optional] +**discovered_at** | **datetime** | The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. | [optional] +**created_at** | **datetime** | The timestamp when the application was first discovered, in ISO 8601 format. | [optional] +**status** | **str** | The status of an application within the discovery source. By default this field is set to \"ACTIVE\" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to \"INACTIVE\". | [optional] +**associated_sources** | **[]str** | List of associated sources related to this discovered application. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.get_discovered_applications200_response_inner import GetDiscoveredApplications200ResponseInner + +get_discovered_applications200_response_inner = GetDiscoveredApplications200ResponseInner( +id='', +name='ExampleApp', +discovery_source='csv', +discovered_vendor='ExampleVendor', +description='An application for managing examples.', +recommended_connectors=[ConnectorA, ConnectorB], +discovered_at='2023-01-01T12:00Z', +created_at='2023-01-01T12:00Z', +status='ACTIVE', +associated_sources=[e0cc5d7d-bf7f-4f81-b2af-8885b09d9923, a0303682-5e4a-44f7-bdc2-6ce6112549c1] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/GetOAuthClientResponse.md b/docs/tools/sdk/python/Reference/V3/Models/GetOAuthClientResponse.md new file mode 100644 index 000000000..f883fb4e2 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/GetOAuthClientResponse.md @@ -0,0 +1,73 @@ +--- +id: get-o-auth-client-response +title: GetOAuthClientResponse +pagination_label: GetOAuthClientResponse +sidebar_label: GetOAuthClientResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'GetOAuthClientResponse', 'GetOAuthClientResponse'] +slug: /tools/sdk/python/v3/models/get-o-auth-client-response +tags: ['SDK', 'Software Development Kit', 'GetOAuthClientResponse', 'GetOAuthClientResponse'] +--- + +# GetOAuthClientResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the OAuth client | [required] +**business_name** | **str** | The name of the business the API Client should belong to | [required] +**homepage_url** | **str** | The homepage URL associated with the owner of the API Client | [required] +**name** | **str** | A human-readable name for the API Client | [required] +**description** | **str** | A description of the API Client | [required] +**access_token_validity_seconds** | **int** | The number of seconds an access token generated for this API Client is valid for | [required] +**refresh_token_validity_seconds** | **int** | The number of seconds a refresh token generated for this API Client is valid for | [required] +**redirect_uris** | **[]str** | A list of the approved redirect URIs used with the authorization_code flow | [required] +**grant_types** | [**[]GrantType**](grant-type) | A list of OAuth 2.0 grant types this API Client can be used with | [required] +**access_type** | [**AccessType**](access-type) | | [required] +**type** | [**ClientType**](client-type) | | [required] +**internal** | **bool** | An indicator of whether the API Client can be used for requests internal to IDN | [required] +**enabled** | **bool** | An indicator of whether the API Client is enabled for use | [required] +**strong_auth_supported** | **bool** | An indicator of whether the API Client supports strong authentication | [required] +**claims_supported** | **bool** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | [required] +**created** | **datetime** | The date and time, down to the millisecond, when the API Client was created | [required] +**modified** | **datetime** | The date and time, down to the millisecond, when the API Client was last updated | [required] +**secret** | **str** | | [optional] +**metadata** | **str** | | [optional] +**last_used** | **datetime** | The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed. | [optional] +**scope** | **[]str** | Scopes of the API Client. | [required] +} + +## Example + +```python +from sailpoint.v3.models.get_o_auth_client_response import GetOAuthClientResponse + +get_o_auth_client_response = GetOAuthClientResponse( +id='2c9180835d2e5168015d32f890ca1581', +business_name='Acme-Solar', +homepage_url='http://localhost:12345', +name='Demo API Client', +description='An API client used for the authorization_code, refresh_token, and client_credentials flows', +access_token_validity_seconds=750, +refresh_token_validity_seconds=86400, +redirect_uris=[http://localhost:12345], +grant_types=[AUTHORIZATION_CODE, CLIENT_CREDENTIALS, REFRESH_TOKEN], +access_type='OFFLINE', +type='CONFIDENTIAL', +internal=False, +enabled=True, +strong_auth_supported=False, +claims_supported=False, +created='2017-07-11T18:45:37.098Z', +modified='2018-06-25T20:22:28.104Z', +secret='', +metadata='', +last_used='2017-07-11T18:45:37.098Z', +scope=[demo:api-client-scope:first, demo:api-client-scope:second] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/GetPersonalAccessTokenResponse.md b/docs/tools/sdk/python/Reference/V3/Models/GetPersonalAccessTokenResponse.md new file mode 100644 index 000000000..2cfb5f9fa --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/GetPersonalAccessTokenResponse.md @@ -0,0 +1,48 @@ +--- +id: get-personal-access-token-response +title: GetPersonalAccessTokenResponse +pagination_label: GetPersonalAccessTokenResponse +sidebar_label: GetPersonalAccessTokenResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'GetPersonalAccessTokenResponse', 'GetPersonalAccessTokenResponse'] +slug: /tools/sdk/python/v3/models/get-personal-access-token-response +tags: ['SDK', 'Software Development Kit', 'GetPersonalAccessTokenResponse', 'GetPersonalAccessTokenResponse'] +--- + +# GetPersonalAccessTokenResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the personal access token (to be used as the username for Basic Auth). | [required] +**name** | **str** | The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. | [required] +**scope** | **[]str** | Scopes of the personal access token. | [required] +**owner** | [**PatOwner**](pat-owner) | | [required] +**created** | **datetime** | The date and time, down to the millisecond, when this personal access token was created. | [required] +**last_used** | **datetime** | The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed. | [optional] +**managed** | **bool** | If true, this token is managed by the SailPoint platform, and is not visible in the user interface. For example, Workflows will create managed personal access tokens for users who create workflows. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v3.models.get_personal_access_token_response import GetPersonalAccessTokenResponse + +get_personal_access_token_response = GetPersonalAccessTokenResponse( +id='86f1dc6fe8f54414950454cbb11278fa', +name='NodeJS Integration', +scope=[demo:personal-access-token-scope:first, demo:personal-access-token-scope:second], +owner=sailpoint.v3.models.pat_owner.PatOwner( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', ), +created='2017-07-11T18:45:37.098Z', +last_used='2017-07-11T18:45:37.098Z', +managed=False +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/GetVendorConnectorMappings405Response.md b/docs/tools/sdk/python/Reference/V3/Models/GetVendorConnectorMappings405Response.md new file mode 100644 index 000000000..22825d96f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/GetVendorConnectorMappings405Response.md @@ -0,0 +1,37 @@ +--- +id: get-vendor-connector-mappings405-response +title: GetVendorConnectorMappings405Response +pagination_label: GetVendorConnectorMappings405Response +sidebar_label: GetVendorConnectorMappings405Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'GetVendorConnectorMappings405Response', 'GetVendorConnectorMappings405Response'] +slug: /tools/sdk/python/v3/models/get-vendor-connector-mappings405-response +tags: ['SDK', 'Software Development Kit', 'GetVendorConnectorMappings405Response', 'GetVendorConnectorMappings405Response'] +--- + +# GetVendorConnectorMappings405Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error_name** | **object** | A message describing the error | [optional] +**error_message** | **object** | Description of the error | [optional] +**tracking_id** | **str** | Unique tracking id for the error. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.get_vendor_connector_mappings405_response import GetVendorConnectorMappings405Response + +get_vendor_connector_mappings405_response = GetVendorConnectorMappings405Response( +error_name=NotSupportedException, +error_message=Cannot consume content type, +tracking_id='e7eab60924f64aa284175b9fa3309599' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/GrantType.md b/docs/tools/sdk/python/Reference/V3/Models/GrantType.md new file mode 100644 index 000000000..5eb811204 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/GrantType.md @@ -0,0 +1,25 @@ +--- +id: grant-type +title: GrantType +pagination_label: GrantType +sidebar_label: GrantType +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'GrantType', 'GrantType'] +slug: /tools/sdk/python/v3/models/grant-type +tags: ['SDK', 'Software Development Kit', 'GrantType', 'GrantType'] +--- + +# GrantType + +OAuth2 Grant Type + +## Enum + +* `CLIENT_CREDENTIALS` (value: `'CLIENT_CREDENTIALS'`) + +* `AUTHORIZATION_CODE` (value: `'AUTHORIZATION_CODE'`) + +* `REFRESH_TOKEN` (value: `'REFRESH_TOKEN'`) + +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/IdentitiesDetailsReportArguments.md b/docs/tools/sdk/python/Reference/V3/Models/IdentitiesDetailsReportArguments.md new file mode 100644 index 000000000..36e0bdfab --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/IdentitiesDetailsReportArguments.md @@ -0,0 +1,34 @@ +--- +id: identities-details-report-arguments +title: IdentitiesDetailsReportArguments +pagination_label: IdentitiesDetailsReportArguments +sidebar_label: IdentitiesDetailsReportArguments +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentitiesDetailsReportArguments', 'IdentitiesDetailsReportArguments'] +slug: /tools/sdk/python/v3/models/identities-details-report-arguments +tags: ['SDK', 'Software Development Kit', 'IdentitiesDetailsReportArguments', 'IdentitiesDetailsReportArguments'] +--- + +# IdentitiesDetailsReportArguments + +Arguments for Identities Details report (IDENTITIES_DETAILS) + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**correlated_only** | **bool** | Flag to specify if only correlated identities are included in report. | [required][default to False] +} + +## Example + +```python +from sailpoint.v3.models.identities_details_report_arguments import IdentitiesDetailsReportArguments + +identities_details_report_arguments = IdentitiesDetailsReportArguments( +correlated_only=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/IdentitiesReportArguments.md b/docs/tools/sdk/python/Reference/V3/Models/IdentitiesReportArguments.md new file mode 100644 index 000000000..63b0e8b58 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/IdentitiesReportArguments.md @@ -0,0 +1,34 @@ +--- +id: identities-report-arguments +title: IdentitiesReportArguments +pagination_label: IdentitiesReportArguments +sidebar_label: IdentitiesReportArguments +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentitiesReportArguments', 'IdentitiesReportArguments'] +slug: /tools/sdk/python/v3/models/identities-report-arguments +tags: ['SDK', 'Software Development Kit', 'IdentitiesReportArguments', 'IdentitiesReportArguments'] +--- + +# IdentitiesReportArguments + +Arguments for Identities report (IDENTITIES) + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**correlated_only** | **bool** | Flag to specify if only correlated identities are included in report. | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v3.models.identities_report_arguments import IdentitiesReportArguments + +identities_report_arguments = IdentitiesReportArguments( +correlated_only=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/IdentityAccess.md b/docs/tools/sdk/python/Reference/V3/Models/IdentityAccess.md new file mode 100644 index 000000000..0f7b3cdb8 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/IdentityAccess.md @@ -0,0 +1,59 @@ +--- +id: identity-access +title: IdentityAccess +pagination_label: IdentityAccess +sidebar_label: IdentityAccess +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityAccess', 'IdentityAccess'] +slug: /tools/sdk/python/v3/models/identity-access +tags: ['SDK', 'Software Development Kit', 'IdentityAccess', 'IdentityAccess'] +--- + +# IdentityAccess + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the referenced object. | [optional] +**name** | **str** | The human readable name of the referenced object. | [optional] +**display_name** | **str** | | [optional] +**description** | **str** | Description of access item. | [optional] +**type** | **str** | Type of the access item. | [optional] +**source** | [**Reference**](reference) | | [optional] +**owner** | [**DisplayReference**](display-reference) | | [optional] +**revocable** | **bool** | | [optional] +**privileged** | **bool** | | [optional] +**attribute** | **str** | | [optional] +**value** | **str** | | [optional] +**standalone** | **bool** | | [optional] +**disabled** | **bool** | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.identity_access import IdentityAccess + +identity_access = IdentityAccess( +id='2c91808568c529c60168cca6f90c1313', +name='John Doe', +display_name='John Q. Doe', +description='', +type='ROLE', +source=sailpoint.v3.models.reference.Reference( + id = '2c91808568c529c60168cca6f90c1313', + name = 'John Doe', ), +owner=, +revocable=True, +privileged=False, +attribute='memberOf', +value='CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com', +standalone=False, +disabled=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/IdentityAttributeConfig.md b/docs/tools/sdk/python/Reference/V3/Models/IdentityAttributeConfig.md new file mode 100644 index 000000000..cbd093e32 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/IdentityAttributeConfig.md @@ -0,0 +1,42 @@ +--- +id: identity-attribute-config +title: IdentityAttributeConfig +pagination_label: IdentityAttributeConfig +sidebar_label: IdentityAttributeConfig +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityAttributeConfig', 'IdentityAttributeConfig'] +slug: /tools/sdk/python/v3/models/identity-attribute-config +tags: ['SDK', 'Software Development Kit', 'IdentityAttributeConfig', 'IdentityAttributeConfig'] +--- + +# IdentityAttributeConfig + +Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | Backend will only promote values if the profile/mapping is enabled. | [optional] [default to False] +**attribute_transforms** | [**[]IdentityAttributeTransform**](identity-attribute-transform) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.identity_attribute_config import IdentityAttributeConfig + +identity_attribute_config = IdentityAttributeConfig( +enabled=True, +attribute_transforms=[ + sailpoint.v3.models.identity_attribute_transform.IdentityAttributeTransform( + identity_attribute_name = 'email', + transform_definition = sailpoint.v3.models.transform_definition.TransformDefinition( + type = 'accountAttribute', + attributes = {attributeName=e-mail, sourceName=MySource, sourceId=2c9180877a826e68017a8c0b03da1a53}, ), ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/IdentityAttributePreview.md b/docs/tools/sdk/python/Reference/V3/Models/IdentityAttributePreview.md new file mode 100644 index 000000000..6894ce02e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/IdentityAttributePreview.md @@ -0,0 +1,44 @@ +--- +id: identity-attribute-preview +title: IdentityAttributePreview +pagination_label: IdentityAttributePreview +sidebar_label: IdentityAttributePreview +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityAttributePreview', 'IdentityAttributePreview'] +slug: /tools/sdk/python/v3/models/identity-attribute-preview +tags: ['SDK', 'Software Development Kit', 'IdentityAttributePreview', 'IdentityAttributePreview'] +--- + +# IdentityAttributePreview + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the attribute that is being previewed. | [optional] +**value** | **str** | Value that was derived during the preview. | [optional] +**previous_value** | **str** | The value of the attribute before the preview. | [optional] +**error_messages** | [**[]ErrorMessageDto**](error-message-dto) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.identity_attribute_preview import IdentityAttributePreview + +identity_attribute_preview = IdentityAttributePreview( +name='email', +value='email@mail.com', +previous_value='oldEmail@mail.com', +error_messages=[ + sailpoint.v3.models.error_message_dto.ErrorMessageDto( + locale = 'en-US', + locale_origin = 'DEFAULT', + text = 'The request was syntactically correct but its content is semantically invalid.', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/IdentityAttributeTransform.md b/docs/tools/sdk/python/Reference/V3/Models/IdentityAttributeTransform.md new file mode 100644 index 000000000..42839d5ff --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/IdentityAttributeTransform.md @@ -0,0 +1,38 @@ +--- +id: identity-attribute-transform +title: IdentityAttributeTransform +pagination_label: IdentityAttributeTransform +sidebar_label: IdentityAttributeTransform +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityAttributeTransform', 'IdentityAttributeTransform'] +slug: /tools/sdk/python/v3/models/identity-attribute-transform +tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform', 'IdentityAttributeTransform'] +--- + +# IdentityAttributeTransform + +Transform definition for an identity attribute. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_attribute_name** | **str** | Identity attribute's name. | [optional] +**transform_definition** | [**TransformDefinition**](transform-definition) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.identity_attribute_transform import IdentityAttributeTransform + +identity_attribute_transform = IdentityAttributeTransform( +identity_attribute_name='email', +transform_definition=sailpoint.v3.models.transform_definition.TransformDefinition( + type = 'accountAttribute', + attributes = {attributeName=e-mail, sourceName=MySource, sourceId=2c9180877a826e68017a8c0b03da1a53}, ) +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/IdentityCertDecisionSummary.md b/docs/tools/sdk/python/Reference/V3/Models/IdentityCertDecisionSummary.md new file mode 100644 index 000000000..22608ab44 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/IdentityCertDecisionSummary.md @@ -0,0 +1,63 @@ +--- +id: identity-cert-decision-summary +title: IdentityCertDecisionSummary +pagination_label: IdentityCertDecisionSummary +sidebar_label: IdentityCertDecisionSummary +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityCertDecisionSummary', 'IdentityCertDecisionSummary'] +slug: /tools/sdk/python/v3/models/identity-cert-decision-summary +tags: ['SDK', 'Software Development Kit', 'IdentityCertDecisionSummary', 'IdentityCertDecisionSummary'] +--- + +# IdentityCertDecisionSummary + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entitlement_decisions_made** | **int** | Number of entitlement decisions that have been made | [optional] +**access_profile_decisions_made** | **int** | Number of access profile decisions that have been made | [optional] +**role_decisions_made** | **int** | Number of role decisions that have been made | [optional] +**account_decisions_made** | **int** | Number of account decisions that have been made | [optional] +**entitlement_decisions_total** | **int** | The total number of entitlement decisions on the certification, both complete and incomplete | [optional] +**access_profile_decisions_total** | **int** | The total number of access profile decisions on the certification, both complete and incomplete | [optional] +**role_decisions_total** | **int** | The total number of role decisions on the certification, both complete and incomplete | [optional] +**account_decisions_total** | **int** | The total number of account decisions on the certification, both complete and incomplete | [optional] +**entitlements_approved** | **int** | The number of entitlement decisions that have been made which were approved | [optional] +**entitlements_revoked** | **int** | The number of entitlement decisions that have been made which were revoked | [optional] +**access_profiles_approved** | **int** | The number of access profile decisions that have been made which were approved | [optional] +**access_profiles_revoked** | **int** | The number of access profile decisions that have been made which were revoked | [optional] +**roles_approved** | **int** | The number of role decisions that have been made which were approved | [optional] +**roles_revoked** | **int** | The number of role decisions that have been made which were revoked | [optional] +**accounts_approved** | **int** | The number of account decisions that have been made which were approved | [optional] +**accounts_revoked** | **int** | The number of account decisions that have been made which were revoked | [optional] +} + +## Example + +```python +from sailpoint.v3.models.identity_cert_decision_summary import IdentityCertDecisionSummary + +identity_cert_decision_summary = IdentityCertDecisionSummary( +entitlement_decisions_made=3, +access_profile_decisions_made=5, +role_decisions_made=2, +account_decisions_made=4, +entitlement_decisions_total=6, +access_profile_decisions_total=10, +role_decisions_total=4, +account_decisions_total=8, +entitlements_approved=2, +entitlements_revoked=1, +access_profiles_approved=3, +access_profiles_revoked=2, +roles_approved=2, +roles_revoked=0, +accounts_approved=1, +accounts_revoked=3 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/IdentityCertificationDto.md b/docs/tools/sdk/python/Reference/V3/Models/IdentityCertificationDto.md new file mode 100644 index 000000000..40834455e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/IdentityCertificationDto.md @@ -0,0 +1,90 @@ +--- +id: identity-certification-dto +title: IdentityCertificationDto +pagination_label: IdentityCertificationDto +sidebar_label: IdentityCertificationDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityCertificationDto', 'IdentityCertificationDto'] +slug: /tools/sdk/python/v3/models/identity-certification-dto +tags: ['SDK', 'Software Development Kit', 'IdentityCertificationDto', 'IdentityCertificationDto'] +--- + +# IdentityCertificationDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | id of the certification | [optional] +**name** | **str** | name of the certification | [optional] +**campaign** | [**CampaignReference**](campaign-reference) | | [optional] +**completed** | **bool** | Have all decisions been made? | [optional] +**identities_completed** | **int** | The number of identities for whom all decisions have been made and are complete. | [optional] +**identities_total** | **int** | The total number of identities in the Certification, both complete and incomplete. | [optional] +**created** | **datetime** | created date | [optional] +**modified** | **datetime** | modified date | [optional] +**decisions_made** | **int** | The number of approve/revoke/acknowledge decisions that have been made. | [optional] +**decisions_total** | **int** | The total number of approve/revoke/acknowledge decisions. | [optional] +**due** | **datetime** | The due date of the certification. | [optional] +**signed** | **datetime** | The date the reviewer signed off on the Certification. | [optional] +**reviewer** | [**Reviewer**](reviewer) | | [optional] +**reassignment** | [**Reassignment**](reassignment) | | [optional] +**has_errors** | **bool** | Identifies if the certification has an error | [optional] +**error_message** | **str** | Description of the certification error | [optional] +**phase** | [**CertificationPhase**](certification-phase) | | [optional] +} + +## Example + +```python +from sailpoint.v3.models.identity_certification_dto import IdentityCertificationDto + +identity_certification_dto = IdentityCertificationDto( +id='2c9180835d2e5168015d32f890ca1581', +name='Source Owner Access Review for Employees [source]', +campaign=sailpoint.v3.models.campaign_reference.CampaignReference( + id = 'ef38f94347e94562b5bb8424a56397d8', + name = 'Campaign Name', + type = 'CAMPAIGN', + campaign_type = 'MANAGER', + description = 'A description of the campaign', + correlated_status = 'CORRELATED', + mandatory_comment_requirement = 'NO_DECISIONS', ), +completed=True, +identities_completed=5, +identities_total=10, +created='2018-06-25T20:22:28.104Z', +modified='2018-06-25T20:22:28.104Z', +decisions_made=20, +decisions_total=40, +due='2018-10-19T13:49:37.385Z', +signed='2018-10-19T13:49:37.385Z', +reviewer=sailpoint.v3.models.reviewer.Reviewer( + id = 'ef38f94347e94562b5bb8424a56397d8', + name = 'Reviewer Name', + email = 'reviewer@test.com', + type = 'IDENTITY', + created = '2018-06-25T20:22:28.104Z', + modified = '2018-06-25T20:22:28.104Z', ), +reassignment=sailpoint.v3.models.reassignment.Reassignment( + from = sailpoint.v3.models.certification_reference.CertificationReference( + id = 'ef38f94347e94562b5bb8424a56397d8', + name = 'Certification Name', + type = 'CERTIFICATION', + reviewer = sailpoint.v3.models.reviewer.Reviewer( + id = 'ef38f94347e94562b5bb8424a56397d8', + name = 'Reviewer Name', + email = 'reviewer@test.com', + type = 'IDENTITY', + created = '2018-06-25T20:22:28.104Z', + modified = '2018-06-25T20:22:28.104Z', ), ), + comment = 'Reassigned for a reason', ), +has_errors=False, +error_message='The certification has an error', +phase='ACTIVE' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/IdentityDocument.md b/docs/tools/sdk/python/Reference/V3/Models/IdentityDocument.md new file mode 100644 index 000000000..293a6fd5b --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/IdentityDocument.md @@ -0,0 +1,151 @@ +--- +id: identity-document +title: IdentityDocument +pagination_label: IdentityDocument +sidebar_label: IdentityDocument +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityDocument', 'IdentityDocument'] +slug: /tools/sdk/python/v3/models/identity-document +tags: ['SDK', 'Software Development Kit', 'IdentityDocument', 'IdentityDocument'] +--- + +# IdentityDocument + +Identity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique ID of the referenced object. | [required] +**name** | **str** | The human readable name of the referenced object. | [required] +**display_name** | **str** | Identity's display name. | [optional] +**first_name** | **str** | Identity's first name. | [optional] +**last_name** | **str** | Identity's last name. | [optional] +**email** | **str** | Identity's primary email address. | [optional] +**created** | **datetime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**modified** | **datetime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional] +**phone** | **str** | Identity's phone number. | [optional] +**synced** | **str** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**inactive** | **bool** | Indicates whether the identity is inactive. | [optional] [default to False] +**protected** | **bool** | Indicates whether the identity is protected. | [optional] [default to False] +**status** | **str** | Identity's status in SailPoint. | [optional] +**employee_number** | **str** | Identity's employee number. | [optional] +**manager** | [**IdentityDocumentAllOfManager**](identity-document-all-of-manager) | | [optional] +**is_manager** | **bool** | Indicates whether the identity is a manager of other identities. | [optional] +**identity_profile** | [**IdentityDocumentAllOfIdentityProfile**](identity-document-all-of-identity-profile) | | [optional] +**source** | [**IdentityDocumentAllOfSource**](identity-document-all-of-source) | | [optional] +**attributes** | **map[string]object** | Map or dictionary of key/value pairs. | [optional] +**disabled** | **bool** | Indicates whether the identity is disabled. | [optional] [default to False] +**locked** | **bool** | Indicates whether the identity is locked. | [optional] [default to False] +**processing_state** | **str** | Identity's processing state. | [optional] +**processing_details** | [**ProcessingDetails**](processing-details) | | [optional] +**accounts** | [**[]BaseAccount**](base-account) | List of accounts associated with the identity. | [optional] +**account_count** | **int** | Number of accounts associated with the identity. | [optional] +**apps** | [**[]App**](app) | List of applications the identity has access to. | [optional] +**app_count** | **int** | Number of applications the identity has access to. | [optional] +**access** | [**[]IdentityAccess**](identity-access) | List of access items assigned to the identity. | [optional] +**access_count** | **int** | Number of access items assigned to the identity. | [optional] +**entitlement_count** | **int** | Number of entitlements assigned to the identity. | [optional] +**role_count** | **int** | Number of roles assigned to the identity. | [optional] +**access_profile_count** | **int** | Number of access profiles assigned to the identity. | [optional] +**owns** | [**[]Owns**](owns) | Access items the identity owns. | [optional] +**owns_count** | **int** | Number of access items the identity owns. | [optional] +**tags** | **[]str** | Tags that have been applied to the object. | [optional] +**tags_count** | **int** | Number of tags on the identity. | [optional] +**visible_segments** | **[]str** | List of segments that the identity is in. | [optional] +**visible_segment_count** | **int** | Number of segments the identity is in. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.identity_document import IdentityDocument + +identity_document = IdentityDocument( +id='2c91808568c529c60168cca6f90c1313', +name='John Doe', +display_name='Carol.Adams', +first_name='Carol', +last_name='Adams', +email='Carol.Adams@sailpointdemo.com', +created='2018-06-25T20:22:28.104Z', +modified='2018-06-25T20:22:28.104Z', +phone='+1 440-527-3672', +synced='', +inactive=False, +protected=False, +status='UNREGISTERED', +employee_number='1a2a3d4e', +manager=sailpoint.v3.models.identity_document_all_of_manager.IdentityDocument_allOf_manager( + id = '2c9180867dfe694b017e208e27c05799', + name = 'Amanda.Ross', + display_name = 'Amanda.Ross', ), +is_manager=False, +identity_profile=sailpoint.v3.models.identity_document_all_of_identity_profile.IdentityDocument_allOf_identityProfile( + id = '3bc8ad26b8664945866b31339d1ff7d2', + name = 'HR Employees', ), +source=sailpoint.v3.models.identity_document_all_of_source.IdentityDocument_allOf_source( + id = '2c91808b6e9e6fb8016eec1a2b6f7b5f', + name = 'ODS-HR-Employees', ), +attributes={country=US, firstname=Carol, cloudStatus=UNREGISTERED}, +disabled=False, +locked=False, +processing_state='ERROR', +processing_details=sailpoint.v3.models.processing_details.ProcessingDetails( + date = '2018-06-25T20:22:28.104Z', + stage = 'In Process', + retry_count = 0, + stack_trace = '
- {diagram}
-
- );
- } else {
- loadingIndicator = Diagram Loading ...
;
- renderedDiagram = (
-
- {diagram}
-
- );
- }
+
return (
@@ -148,7 +107,7 @@ const MermaidViewer: React.FC = ({ diagram }) => {
/>
![]()
resetWidth(e)}
+ onClick={resetWidth}
src={useBaseUrl('/icons/house-regular.svg')}
alt="Reset Zoom"
/>
@@ -169,8 +128,24 @@ const MermaidViewer: React.FC = ({ diagram }) => {
onTouchEnd={setMouseUp}
onMouseLeave={setMouseUp}
>
- {loadingIndicator}
- {renderedDiagram}
+ {mermaidRender ? (
+
);
diff --git a/src/components/blog/BlogCards/index.tsx b/src/components/blog/BlogCards/index.tsx
index a115e786e..f6f89d84b 100644
--- a/src/components/blog/BlogCards/index.tsx
+++ b/src/components/blog/BlogCards/index.tsx
@@ -29,12 +29,14 @@ interface BlogPost {
readTime: number;
}
-const BlogCards: React.FC
+ {diagram}
+
+ ) : (
+ Diagram Loading ...
+ )}
+ {
+ onItemClick?.(item);
+ if (href) {
+ updateCollapsed(false);
+ } else {
+ e.preventDefault();
+ updateCollapsed();
+ }
+ }
+ : () => {
+ onItemClick?.(item);
+ }
+ }
+ aria-current={isCurrentPage ? 'page' : undefined}
+ role={collapsible && !href ? 'button' : undefined}
+ aria-expanded={collapsible && !href ? !collapsed : undefined}
+ href={collapsible ? hrefWithSSRFallback ?? '#' : hrefWithSSRFallback}
+ {...props}>
+ {label}
+
+ {href && collapsible && (
+ {
+ e.preventDefault();
+ updateCollapsed();
+ }}
+ />
+ )}
+
+
+ Patchable field: **name, + description, approvers, accountManagers** Requires role context of + `idn:nesr:update`. + parameters: + - in: path + name: sourceId + description: >- + Source Id + required: true + x-sailpoint-resource-operation-id: listNonEmployeeSources + schema: + type: string + example: e136567de87e4d029e60b3c3c55db56d + requestBody: + description: + A list of non-employee source update operations according to the [JSON + Patch](https://tools.ietf.org/html/rfc6902) standard. + required: true + content: + application/json-patch+json: + schema: + type: array + items: + $ref: "../schemas/JsonPatchOperation.yaml" + example: + - op: "replace" + path: "/name" + value: { "new name" } + - op: "replace" + path: "/approvers" + value: + [ + "2c91809f703bb37a017040a2fe8748c7", + "48b1f463c9e8427db5a5071bd81914b8", + ] + responses: + "200": + description: A patched non-employee source object. + content: + application/json: + schema: + $ref: "../schemas/non-employee/NonEmployeeSource.yaml" + "400": + $ref: "../responses/400.yaml" + "401": + $ref: "../responses/401.yaml" + "403": + $ref: "../responses/403.yaml" + "429": + $ref: "../responses/429.yaml" + "500": + $ref: "../responses/500.yaml" +delete: + operationId: deleteNonEmployeeSource + # security: + # - oauth2: [idn:nesr:delete] + tags: + - Non-Employee Lifecycle Management + summary: Delete Non-Employee Source + description: >- + This request will delete a non-employee source. Requires role + context of `idn:nesr:delete`. + parameters: + - in: path + name: sourceId + description: >- + Source Id + required: true + x-sailpoint-resource-operation-id: listNonEmployeeSources + schema: + type: string + example: e136567de87e4d029e60b3c3c55db56d + responses: + "204": + $ref: "../responses/204.yaml" + "400": + $ref: "../responses/400.yaml" + "401": + $ref: "../responses/401.yaml" + "403": + $ref: "../responses/403.yaml" + "429": + $ref: "../responses/429.yaml" + "500": + $ref: "../responses/500.yaml" diff --git a/static/api-specs/idn/v2025/paths/non-employee-sources-bulk-upload-details.yaml b/static/api-specs/idn/v2025/paths/non-employee-sources-bulk-upload-details.yaml new file mode 100644 index 000000000..711fa3521 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/non-employee-sources-bulk-upload-details.yaml @@ -0,0 +1,41 @@ +get: + operationId: nonEmployeeBulkUploadDetails + # security: + # - oauth2: [idn:nesr:read] + tags: + - Non-Employee Lifecycle Management + summary: Details of bulk upload job on source + description: | + This API returns the details of the newest bulk upload job for the specified source. + + Requires role context of `idn:nesr:read` + + This is for internal use only. + parameters: + - in: path + name: id + description: >- + Source ID (UUID) + required: true + x-sailpoint-resource-operation-id: listNonEmployeeSources + schema: + type: string + example: e136567de87e4d029e60b3c3c55db56d + responses: + "200": + description: >- + Details of the newest bulk-upload job, if any. + content: + application/json: + schema: + $ref: "../schemas/non-employee/NonEmployeeBulkUploadJob.yaml" + "400": + $ref: "../responses/400.yaml" + "401": + $ref: "../responses/401.yaml" + "403": + $ref: "../responses/403.yaml" + "429": + $ref: "../responses/429.yaml" + "500": + $ref: "../responses/500.yaml" diff --git a/static/api-specs/idn/v2025/paths/non-employee-sources-bulk-upload-non-employees.yaml b/static/api-specs/idn/v2025/paths/non-employee-sources-bulk-upload-non-employees.yaml new file mode 100644 index 000000000..1a9f52c68 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/non-employee-sources-bulk-upload-non-employees.yaml @@ -0,0 +1,57 @@ +post: + operationId: importNonEmployeeRecordsInBulk + security: + - userAuth: [idn:nelm:manage] + tags: + - Non-Employee Lifecycle Management + summary: Imports, or Updates, Non-Employee Records + description: >- + This post will import, or update, Non-Employee records found in the CSV. + Requires role context of `idn:nesr:create` + parameters: + - in: path + name: id + description: >- + Source Id (UUID) + required: true + x-sailpoint-resource-operation-id: listNonEmployeeSources + schema: + type: string + example: e136567de87e4d029e60b3c3c55db56d + requestBody: + content: + multipart/form-data: + schema: + type: object + properties: + data: + type: string + format: binary + required: + - data + responses: + "202": + description: >- + The CSV was accepted to be bulk inserted now or at a later time. + content: + application/json: + schema: + $ref: "../schemas/non-employee/NonEmployeeBulkUploadJob.yaml" + "400": + description: | + Client Error - Returned if the request body is invalid. + The response body will contain the list of specific errors with one on each line. + content: + application/json: + schema: + $ref: "../schemas/ErrorResponseDto.yaml" + "401": + $ref: "../responses/401.yaml" + "403": + $ref: "../responses/403.yaml" + "404": + $ref: "../responses/404.yaml" + "429": + $ref: "../responses/429.yaml" + "500": + $ref: "../responses/500.yaml" diff --git a/static/api-specs/idn/v2025/paths/non-employee-sources-bulk-upload-status.yaml b/static/api-specs/idn/v2025/paths/non-employee-sources-bulk-upload-status.yaml new file mode 100644 index 000000000..f8e9427b5 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/non-employee-sources-bulk-upload-status.yaml @@ -0,0 +1,38 @@ +get: + operationId: getNonEmployeeBulkUploadStatus + # security: + # - oauth2: [idn:nesr:read] + tags: + - Non-Employee Lifecycle Management + summary: Obtain the status of bulk upload on the source + description: | + The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. + Requires role context of `idn:nesr:read` + parameters: + - in: path + name: id + description: >- + Source ID (UUID) + required: true + x-sailpoint-resource-operation-id: listNonEmployeeSources + schema: + type: string + example: e136567de87e4d029e60b3c3c55db56d + responses: + "200": + description: >- + Status of the newest bulk-upload job, if any. + content: + application/json: + schema: + $ref: "../schemas/non-employee/NonEmployeeBulkUploadStatus.yaml" + "400": + $ref: "../responses/400.yaml" + "401": + $ref: "../responses/401.yaml" + "403": + $ref: "../responses/403.yaml" + "429": + $ref: "../responses/429.yaml" + "500": + $ref: "../responses/500.yaml" diff --git a/static/api-specs/idn/v2025/paths/non-employee-sources-export-non-employees.yaml b/static/api-specs/idn/v2025/paths/non-employee-sources-export-non-employees.yaml new file mode 100644 index 000000000..8abe7abf0 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/non-employee-sources-export-non-employees.yaml @@ -0,0 +1,41 @@ +get: + operationId: exportNonEmployeeRecords + # security: + # - oauth2: [idn:nesr:read] + tags: + - Non-Employee Lifecycle Management + summary: Exports Non-Employee Records to CSV + description: >- + This requests a CSV download for all non-employees from a provided source. + Requires role context of `idn:nesr:read` + parameters: + - in: path + name: id + description: >- + Source Id (UUID) + required: true + x-sailpoint-resource-operation-id: listNonEmployeeSources + schema: + type: string + example: e136567de87e4d029e60b3c3c55db56d + responses: + "200": + description: Exported CSV + content: + text/csv: + example: | + accountName,firstName,lastName,phone,email,manager,startDate,endDate + Jon.Smith, Jon, Smith, 555-555-5555, jon@jon.doe.nope.com, Jim Smith, 2020-04-05T08:00:00-10:00,2020-08-07T19:00:00-10:00 + William.Chaffin, William, Chaffin, 555-555-5555, william@chaffins.nope.com, Bertram Chaffin, 2020-04-05T08:00:00-10:00,2020-08-07T19:00:00-10:00 + "400": + $ref: "../responses/400.yaml" + "401": + $ref: "../responses/401.yaml" + "403": + $ref: "../responses/403.yaml" + "404": + $ref: "../responses/404.yaml" + "429": + $ref: "../responses/429.yaml" + "500": + $ref: "../responses/500.yaml" diff --git a/static/api-specs/idn/v2025/paths/non-employee-sources-export-schema-attributes-template.yaml b/static/api-specs/idn/v2025/paths/non-employee-sources-export-schema-attributes-template.yaml new file mode 100644 index 000000000..14887462b --- /dev/null +++ b/static/api-specs/idn/v2025/paths/non-employee-sources-export-schema-attributes-template.yaml @@ -0,0 +1,39 @@ +get: + operationId: exportNonEmployeeSourceSchemaTemplate + # security: + # - oauth2: [idn:nesr:read] + tags: + - Non-Employee Lifecycle Management + summary: Exports Source Schema Template + description: >- + This requests a download for the Source Schema Template for a provided + source. Requires role context of `idn:nesr:read` + parameters: + - in: path + name: id + description: >- + Source Id (UUID) + required: true + x-sailpoint-resource-operation-id: listNonEmployeeSources + example: ef38f94347e94562b5bb8424a56397d8 + schema: + type: string + responses: + "200": + description: Exported Source Schema Template + content: + text/csv: + example: | + accountName,firstName,lastName,phone,email,manager,startDate,endDate + "400": + $ref: "../responses/400.yaml" + "401": + $ref: "../responses/401.yaml" + "403": + $ref: "../responses/403.yaml" + "404": + $ref: "../responses/404.yaml" + "429": + $ref: "../responses/429.yaml" + "500": + $ref: "../responses/500.yaml" diff --git a/static/api-specs/idn/v2025/paths/non-employee-sources-schema-attribute.yaml b/static/api-specs/idn/v2025/paths/non-employee-sources-schema-attribute.yaml new file mode 100644 index 000000000..e9ef91e0e --- /dev/null +++ b/static/api-specs/idn/v2025/paths/non-employee-sources-schema-attribute.yaml @@ -0,0 +1,149 @@ +get: + operationId: getNonEmployeeSchemaAttribute + security: + - userAuth: [] + tags: + - Non-Employee Lifecycle Management + summary: Get Schema Attribute Non-Employee Source + description: >- + This API gets a schema attribute by Id for the specified Non-Employee + SourceId. Requires role context of `idn:nesr:read` or the user must be an + account manager of the source. + parameters: + - in: path + name: attributeId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getNonEmployeeSourceSchemaAttributes + example: ef38f94347e94562b5bb8424a56397d8 + description: The Schema Attribute Id (UUID) + - in: path + name: sourceId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listNonEmployeeSources + example: ef38f94347e94562b5bb8424a56397d8 + description: The Source id + responses: + "200": + description: The Schema Attribute + content: + application/json: + schema: + $ref: "../schemas/non-employee/NonEmployeeSchemaAttribute.yaml" + "400": + $ref: "../responses/400.yaml" + "401": + $ref: "../responses/401.yaml" + "403": + $ref: "../responses/403.yaml" + "429": + $ref: "../responses/429.yaml" + "500": + $ref: "../responses/500.yaml" +patch: + operationId: patchNonEmployeeSchemaAttribute + # security: + # - oauth2: [idn:nesr:update] + tags: + - Non-Employee Lifecycle Management + summary: Patch a Schema Attribute for Non-Employee Source + description: | + This end-point patches a specific schema attribute for a non-employee SourceId. + Requires role context of `idn:nesr:update` + parameters: + - in: path + name: attributeId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getNonEmployeeSourceSchemaAttributes + description: The Schema Attribute Id (UUID) + example: ef38f94347e94562b5bb8424a56397d8 + - in: path + name: sourceId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listNonEmployeeSources + description: The Source id + example: ef38f94347e94562b5bb8424a56397d8 + requestBody: + description: + A list of schema attribute update operations according to the [JSON + Patch](https://tools.ietf.org/html/rfc6902) standard. The following + properties are allowed for update ':' 'label', 'helpText', 'placeholder', + 'required'. + content: + application/json-patch+json: + schema: + type: array + items: + $ref: "../schemas/JsonPatchOperation.yaml" + example: + - op: "replace" + path: "/label" + value: { "new attribute label" } + required: true + responses: + "200": + description: The Schema Attribute was successfully patched. + content: + application/json: + schema: + $ref: "../schemas/non-employee/NonEmployeeSchemaAttribute.yaml" + "400": + $ref: "../responses/400.yaml" + "401": + $ref: "../responses/401.yaml" + "403": + $ref: "../responses/403.yaml" + "404": + $ref: "../responses/404.yaml" + "429": + $ref: "../responses/429.yaml" + "500": + $ref: "../responses/500.yaml" +delete: + operationId: deleteNonEmployeeSchemaAttribute + # security: + # - oauth2: [idn:nesr:delete] + tags: + - Non-Employee Lifecycle Management + summary: Delete a Schema Attribute for Non-Employee Source + description: | + This end-point deletes a specific schema attribute for a non-employee source. + Requires role context of `idn:nesr:delete` + parameters: + - in: path + name: attributeId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getNonEmployeeSourceSchemaAttributes + description: The Schema Attribute Id (UUID) + example: ef38f94347e94562b5bb8424a56397d8 + - in: path + name: sourceId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listNonEmployeeSources + description: The Source id + example: ef38f94347e94562b5bb8424a56397d8 + responses: + "204": + $ref: "../responses/204.yaml" + description: The Schema Attribute was successfully deleted. + "400": + $ref: "../responses/400.yaml" + "401": + $ref: "../responses/401.yaml" + "403": + $ref: "../responses/403.yaml" + "429": + $ref: "../responses/429.yaml" + "500": + $ref: "../responses/500.yaml" diff --git a/static/api-specs/idn/v2025/paths/non-employee-sources-schema-attributes.yaml b/static/api-specs/idn/v2025/paths/non-employee-sources-schema-attributes.yaml new file mode 100644 index 000000000..31e589f3a --- /dev/null +++ b/static/api-specs/idn/v2025/paths/non-employee-sources-schema-attributes.yaml @@ -0,0 +1,124 @@ +get: + operationId: getNonEmployeeSourceSchemaAttributes + security: + - userAuth: [] + tags: + - Non-Employee Lifecycle Management + summary: List Schema Attributes Non-Employee Source + description: This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 + mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can + add up to 10 custom attributes. This interface returns all the mandatory attributes followed by + any custom attributes. At most, a total of 18 attributes will be returned. + + Requires role context of `idn:nesr:read` or the user must be an account manager of the source. + parameters: + - in: path + name: sourceId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listNonEmployeeSources + example: ef38f94347e94562b5bb8424a56397d8 + description: The Source id + responses: + "200": + description: A list of Schema Attributes + content: + application/json: + schema: + type: array + items: + $ref: "../schemas/non-employee/NonEmployeeSchemaAttribute.yaml" + maxItems: 18 + "400": + $ref: "../responses/400.yaml" + "401": + $ref: "../responses/401.yaml" + "403": + $ref: "../responses/403.yaml" + "404": + $ref: "../responses/404.yaml" + "429": + $ref: "../responses/429.yaml" + "500": + $ref: "../responses/500.yaml" +post: + operationId: createNonEmployeeSourceSchemaAttributes + # security: + # - oauth2: [idn:nesr:create] + tags: + - Non-Employee Lifecycle Management + summary: Create a new Schema Attribute for Non-Employee Source + description: >- + This API creates a new schema attribute for Non-Employee Source. The schema technical name must be + unique in the source. Attempts to create a schema attribute with an existing name will result in a + "400.1.409 Reference conflict" response. At most, 10 custom attributes can be created per schema. Attempts + to create more than 10 will result in a "400.1.4 Limit violation" response. + + Requires role context of `idn:nesr:create` + parameters: + - in: path + name: sourceId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listNonEmployeeSources + description: The Source id + example: ef38f94347e94562b5bb8424a56397d8 + requestBody: + required: true + content: + application/json: + schema: + $ref: "../schemas/non-employee/NonEmployeeSchemaAttributeBody.yaml" + responses: + "200": + description: >- + Schema Attribute created. + content: + application/json: + schema: + $ref: "../schemas/non-employee/NonEmployeeSchemaAttribute.yaml" + "400": + $ref: "../responses/400.yaml" + "401": + $ref: "../responses/401.yaml" + "403": + $ref: "../responses/403.yaml" + "429": + $ref: "../responses/429.yaml" + "500": + $ref: "../responses/500.yaml" +delete: + operationId: deleteNonEmployeeSourceSchemaAttributes + # security: + # - oauth2: [idn:nesr:delete] + tags: + - Non-Employee Lifecycle Management + summary: Delete all custom schema attributes for Non-Employee Source + description: >- + This end-point deletes all custom schema attributes for a non-employee source. + Requires role context of `idn:nesr:delete` + parameters: + - in: path + name: sourceId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listNonEmployeeSources + description: The Source id + example: ef38f94347e94562b5bb8424a56397d8 + responses: + "204": + $ref: "../responses/204.yaml" + description: All custon Schema Attributes were successfully deleted. + "400": + $ref: "../responses/400.yaml" + "401": + $ref: "../responses/401.yaml" + "403": + $ref: "../responses/403.yaml" + "429": + $ref: "../responses/429.yaml" + "500": + $ref: "../responses/500.yaml" diff --git a/static/api-specs/idn/v2025/paths/non-employee-sources.yaml b/static/api-specs/idn/v2025/paths/non-employee-sources.yaml new file mode 100644 index 000000000..0f25d5ab5 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/non-employee-sources.yaml @@ -0,0 +1,100 @@ +post: + operationId: createNonEmployeeSource + security: + - userAuth: [idn:nelm:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + tags: + - Non-Employee Lifecycle Management + summary: Create Non-Employee Source + description: >- + Create a non-employee source. + requestBody: + description: Non-Employee source creation request body. + required: true + content: + application/json: + schema: + $ref: "../schemas/non-employee/NonEmployeeSourceRequestBody.yaml" + responses: + "200": + description: Created non-employee source. + content: + application/json: + schema: + $ref: "../schemas/non-employee/NonEmployeeSourceWithCloudExternalId.yaml" + "400": + $ref: "../responses/400.yaml" + "401": + $ref: "../responses/401.yaml" + "403": + $ref: "../responses/403.yaml" + "429": + $ref: "../responses/429.yaml" + "500": + $ref: "../responses/500.yaml" +get: + operationId: listNonEmployeeSources + security: + - userAuth: [idn:nelm:read] + x-sailpoint-userLevels: + - ORG_ADMIN + tags: + - Non-Employee Lifecycle Management + summary: List Non-Employee Sources + description: >- + Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: + 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager's `id`. + 2. If the current user is an account manager, the user should provide 'me' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. + parameters: + - $ref: "../parameters/limit.yaml" + - $ref: "../parameters/offset.yaml" + - $ref: "../parameters/count.yaml" + - in: query + name: requested-for + required: false + schema: + type: string + example: me + description: >- + Identity the request was made for. Use 'me' to indicate the current user. + - in: query + name: non-employee-count + required: false + example: true + schema: + type: boolean + default: false + description: >- + Flag that determines whether the API will return a non-employee count associated with the source. + - in: query + name: sorters + required: false + schema: + type: string + format: comma-separated + example: "name,created" + description: >- + Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **name, created, sourceId** + responses: + "200": + description: List of non-employee sources objects. + content: + application/json: + schema: + type: array + items: + $ref: "../schemas/non-employee/NonEmployeeSourceWithNECount.yaml" + "400": + $ref: "../responses/400.yaml" + "401": + $ref: "../responses/401.yaml" + "403": + $ref: "../responses/403.yaml" + "429": + $ref: "../responses/429.yaml" + "500": + $ref: "../responses/500.yaml" diff --git a/static/api-specs/idn/v2025/paths/notification-preference.yaml b/static/api-specs/idn/v2025/paths/notification-preference.yaml new file mode 100644 index 000000000..5d91fa610 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/notification-preference.yaml @@ -0,0 +1,83 @@ +get: + operationId: getNotificationPreference + tags: + - Notifications + summary: Get Notification Preference details + description: >- + Returns the notification preference details for tenant. Note that if the key doesn't exist, then a 404 will be returned. + + security: + - userAuth: [ idn:notification-preferences:read ] + parameters: + - in: path + name: key + required: true + x-sailpoint-resource-operation-id: listNotificationPreferences + example: cloud_manual_work_item_summary + schema: + type: string + description: The notification key. + responses: + '200': + description: Return preference for the given notification key. + content: + application/json: + schema: + $ref: '../schemas/PreferencesDto.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +put: + operationId: putNotificationPreference + tags: + - Notifications + summary: Overwrite preferences notification key. + description: >- + Allows admins to opt in to or out of certain notifications for their org. The default state is opted in. `key` is optional but if it is provided and doesn't match the key in the URI, then a 400 will be thrown. + + security: + - userAuth: [ idn:notification-preferences:create ] + + parameters: + - in: path + name: key + required: true + x-sailpoint-resource-operation-id: listNotificationPreferences + example: cloud_manual_work_item_summary + schema: + type: string + description: The notification key. + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/PreferencesDto.yaml' + responses: + '200': + description: The preferences were successfully replaced, and an echo of the new preferences are sent back to caller. + content: + application/json: + schema: + $ref: '../schemas/PreferencesDto.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/notification-preferences.yaml b/static/api-specs/idn/v2025/paths/notification-preferences.yaml new file mode 100644 index 000000000..c37f5f914 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/notification-preferences.yaml @@ -0,0 +1,37 @@ +get: + operationId: listNotificationPreferences + tags: + - Notifications + summary: List Notification Preferences for tenant. + description: Returns a list of notification preferences for tenant. + security: + - userAuth: + - idn:notification-preferences:read + responses: + '200': + description: Return preference for the given notification key. + content: + application/json: + schema: + $ref: ../schemas/PreferencesDto.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true diff --git a/static/api-specs/idn/v2025/paths/notification-template-context.yaml b/static/api-specs/idn/v2025/paths/notification-template-context.yaml new file mode 100644 index 000000000..e3cb87ecd --- /dev/null +++ b/static/api-specs/idn/v2025/paths/notification-template-context.yaml @@ -0,0 +1,39 @@ +get: + operationId: getNotificationsTemplateContext + tags: + - Notifications + summary: Get Notification Template Context + description: "The notification service maintains metadata to construct the notification\ + \ templates or supply any information during the event propagation. The data-store\ + \ where this information is retrieved is called \"Global Context\" (a.k.a. notification\ + \ template context). It defines a set of attributes\n that will be available per\ + \ tenant (organization)." + security: + - userAuth: + - idn:notification-templates:read + responses: + '200': + description: Notification template context attributes for a specific tenant. + content: + application/json: + schema: + $ref: ../schemas/NotificationTemplateContext.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true diff --git a/static/api-specs/idn/v2025/paths/notification-template-defaults.yaml b/static/api-specs/idn/v2025/paths/notification-template-defaults.yaml new file mode 100644 index 000000000..fa7509710 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/notification-template-defaults.yaml @@ -0,0 +1,59 @@ +get: + operationId: listNotificationTemplateDefaults + tags: + - Notifications + summary: List Notification Template Defaults + description: This lists the default templates used for notifications, such as emails + from IdentityNow. + security: + - userAuth: + - idn:notification-template-defaults:read + parameters: + - $ref: ../parameters/limit.yaml + - $ref: ../parameters/offset.yaml + - in: query + name: filters + schema: + type: string + example: key eq "cloud_manual_work_item_summary" + description: '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: + + + **key**: *eq, in, sw* + + + **medium**: *eq, sw* + + + **locale**: *eq, sw*' + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: A list of the default template objects + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/TemplateDtoDefault.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/notification-template.yaml b/static/api-specs/idn/v2025/paths/notification-template.yaml new file mode 100644 index 000000000..c81f5a5b3 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/notification-template.yaml @@ -0,0 +1,42 @@ +get: + operationId: getNotificationTemplate + tags: + - Notifications + summary: Get Notification Template By Id + description: This gets a template that you have modified for your site by Id. + parameters: + - name: id + in: path + description: Id of the Notification Template + required: true + x-sailpoint-resource-operation-id: listNotificationTemplates + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: A template object for your site + content: + application/json: + schema: + $ref: ../schemas/TemplateDto.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/notification-templates-bulk-delete.yaml b/static/api-specs/idn/v2025/paths/notification-templates-bulk-delete.yaml new file mode 100644 index 000000000..35cf6407e --- /dev/null +++ b/static/api-specs/idn/v2025/paths/notification-templates-bulk-delete.yaml @@ -0,0 +1,40 @@ +post: + operationId: deleteNotificationTemplatesInBulk + tags: + - Notifications + summary: Bulk Delete Notification Templates + description: This lets you bulk delete templates that you previously created for + your site. Since this is a beta feature, please contact support to enable usage. + security: + - userAuth: + - idn:notification-templates:delete + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/TemplateBulkDeleteDto.yaml + responses: + '204': + $ref: ../responses/204.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true diff --git a/static/api-specs/idn/v2025/paths/notification-templates.yaml b/static/api-specs/idn/v2025/paths/notification-templates.yaml new file mode 100644 index 000000000..1ea8868b5 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/notification-templates.yaml @@ -0,0 +1,104 @@ +get: + operationId: listNotificationTemplates + tags: + - Notifications + summary: List Notification Templates + description: This lists the templates that you have modified for your site. + security: + - userAuth: + - idn:notification-templates:read + parameters: + - $ref: ../parameters/limit.yaml + - $ref: ../parameters/offset.yaml + - in: query + name: filters + schema: + type: string + description: '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: + + + **key**: *eq, in, sw* + + + **medium**: *eq, sw* + + + **locale**: *eq, sw*' + example: medium eq "EMAIL" + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: A list of template objects for your site + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/TemplateDto.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml +post: + operationId: createNotificationTemplate + tags: + - Notifications + summary: Create Notification Template + description: "This creates a template for your site. \n\nYou can also use this endpoint\ + \ to update a template. First, copy the response body from the [get notification\ + \ template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template)\ + \ for a template you wish to update and paste it into the request body for this\ + \ endpoint. Modify the fields you want to change and submit the POST request\ + \ when ready." + security: + - userAuth: + - idn:notification-templates:create + requestBody: + required: true + content: + application/json: + schema: + $ref: ../schemas/TemplateDto.yaml + responses: + '200': + description: A template object for your site + content: + application/json: + schema: + $ref: ../schemas/TemplateDto.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true diff --git a/static/api-specs/idn/v2025/paths/oauth-client.yaml b/static/api-specs/idn/v2025/paths/oauth-client.yaml new file mode 100644 index 000000000..2a7e282b4 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/oauth-client.yaml @@ -0,0 +1,142 @@ +get: + operationId: getOauthClient + security: + - userAuth: [sp:oauth-client:manage, sp:oauth-client:read] + tags: + - OAuth Clients + summary: Get OAuth Client + description: >- + This gets details of an OAuth client. + + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listOauthClients + description: The OAuth client id + example: ef38f94347e94562b5bb8424a56397d8 + responses: + '200': + description: Request succeeded. + content: + application/json: + schema: + $ref: '../schemas/GetOAuthClientResponse.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +delete: + operationId: deleteOauthClient + security: + - userAuth: [sp:oauth-client:manage] + tags: + - OAuth Clients + summary: Delete OAuth Client + description: >- + This deletes an OAuth client. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listOauthClients + description: The OAuth client id + example: ef38f94347e94562b5bb8424a56397d8 + responses: + '204': + description: No content. + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +patch: + operationId: patchOauthClient + security: + - userAuth: [sp:oauth-client:manage] + tags: + - OAuth Clients + summary: Patch OAuth Client + description: >- + This performs a targeted update to the field(s) of an OAuth client. + + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listOauthClients + description: The OAuth client id + example: ef38f94347e94562b5bb8424a56397d8 + requestBody: + required: true + description: | + A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + The following fields are patchable: + * tenant + * businessName + * homepageUrl + * name + * description + * accessTokenValiditySeconds + * refreshTokenValiditySeconds + * redirectUris + * grantTypes + * accessType + * enabled + * strongAuthSupported + * claimsSupported + content: + application/json-patch+json: + schema: + type: array + items: + $ref: '../schemas/JsonPatchOperation.yaml' + example: + - op: "replace" + path: "/strongAuthSupported" + value: true + - op: "replace" + path: "/businessName" + value: "acme-solar" + responses: + '200': + description: >- + Indicates the PATCH operation succeeded, and returns the OAuth client's new representation. + content: + application/json: + schema: + $ref: '../schemas/GetOAuthClientResponse.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/oauth-clients.yaml b/static/api-specs/idn/v2025/paths/oauth-clients.yaml new file mode 100644 index 000000000..c38f3c7ae --- /dev/null +++ b/static/api-specs/idn/v2025/paths/oauth-clients.yaml @@ -0,0 +1,79 @@ +get: + operationId: listOauthClients + security: + - userAuth: [sp:oauth-client:manage] + tags: + - OAuth Clients + summary: List OAuth Clients + description: >- + This gets a list of OAuth clients. + parameters: + - in: query + name: filters + required: false + schema: + type: string + description: >- + 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: + + + **lastUsed**: *le, isnull* + example: lastUsed le 2023-02-05T10:59:27.214Z + + responses: + '200': + description: List of OAuth clients. + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/GetOAuthClientResponse.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +post: + operationId: createOauthClient + security: + - userAuth: [sp:oauth-client:manage] + tags: + - OAuth Clients + summary: Create OAuth Client + description: >- + This creates an OAuth client. + + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/CreateOAuthClientRequest.yaml' + responses: + '200': + description: Request succeeded. + content: + application/json: + schema: + $ref: '../schemas/CreateOAuthClientResponse.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/org-config-valid-time-zones.yaml b/static/api-specs/idn/v2025/paths/org-config-valid-time-zones.yaml new file mode 100644 index 000000000..9a4a092f8 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/org-config-valid-time-zones.yaml @@ -0,0 +1,52 @@ +get: + operationId: getValidTimeZones + tags: + - Org Config + summary: Get Valid Time Zones + security: + - userAuth: + - idn:org-configs:read + - idn:org-configs-user:read + x-sailpoint-userLevels: + - ORG_ADMIN + description: List the valid time zones that can be set in organization configurations. + responses: + '200': + description: Request successful. + content: + application/json: + schema: + type: array + items: + type: string + example: + - Etc/GMT-6 + - Etc/GMT+8 + - EST + - America/Chicago + - America/Toronto + - Asia/Gaza + - Europe/Brussels + - Europe/Kiev + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + - $ref: '../parameters/limit50.yaml' + - $ref: '../parameters/offset.yaml' + - $ref: '../parameters/count.yaml' diff --git a/static/api-specs/idn/v2025/paths/org-config.yaml b/static/api-specs/idn/v2025/paths/org-config.yaml new file mode 100644 index 000000000..9801a1f4c --- /dev/null +++ b/static/api-specs/idn/v2025/paths/org-config.yaml @@ -0,0 +1,95 @@ +get: + operationId: getOrgConfig + tags: + - Org Config + summary: Get Org Config Settings + security: + - userAuth: + - idn:org-configs:read + - idn:org-configs:manage + x-sailpoint-userLevels: + - ORG_ADMIN + description: Get the current organization's configuration settings, only external accessible properties. + responses: + '200': + description: Request succeeded. + content: + application/json: + schema: + $ref: ../schemas/OrgConfig.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true +patch: + operationId: patchOrgConfig + tags: + - Org Config + summary: Patch Org Config + security: + - userAuth: + - idn:org-configs:manage + x-sailpoint-userLevels: + - ORG_ADMIN + description: Patch the current organization's configuration, using http://jsonpatch.com/ + syntax. This is commonly used to changing an organization's time zone. + requestBody: + description: A list of schema attribute update operations according to the [JSON + Patch](https://tools.ietf.org/html/rfc6902) standard. + content: + application/json-patch+json: + schema: + type: array + items: + $ref: ../schemas/JsonPatchOperation.yaml + example: + - op: replace + path: /timeZone + value: America/Toronto + required: true + responses: + '200': + description: Successfully patched org config. + content: + application/json: + schema: + $ref: ../schemas/OrgConfig.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + diff --git a/static/api-specs/idn/v2025/paths/outlier-feature-summaries.yaml b/static/api-specs/idn/v2025/paths/outlier-feature-summaries.yaml new file mode 100644 index 000000000..160b7e1ce --- /dev/null +++ b/static/api-specs/idn/v2025/paths/outlier-feature-summaries.yaml @@ -0,0 +1,56 @@ +get: + operationId: getOutlierContributingFeatureSummary + tags: + - IAI Outliers + summary: Get identity outlier contibuting feature summary + description: | + This API returns a summary of a contributing feature for an identity outlier. + + The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object. + parameters: + - in: path + name: outlierFeatureId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getPeerGroupOutliersContributingFeatures + description: Contributing feature id + example: 04654b66-7561-4090-94f9-abee0722a1af + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Succeeded. Returns selected contributing feature summary for an outlier. + headers: + accept-language: + description: The locale to use for translations + schema: + type: string + content: + application/json: + schema: + $ref: ../schemas/OutlierFeatureSummary.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: [iai:outliers:read, iai:outliers:manage] + - applicationAuth: [iai:outliers:read, iai:outliers:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + - REPORT_ADMIN \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/outlier-summaries-latest.yaml b/static/api-specs/idn/v2025/paths/outlier-summaries-latest.yaml new file mode 100644 index 000000000..854b8aaf9 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/outlier-summaries-latest.yaml @@ -0,0 +1,53 @@ +get: + operationId: getLatestIdentityOutlierSnapshots + tags: + - IAI Outliers + summary: IAI Identity Outliers Latest Summary + description: >- + This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier. + parameters: + - name: type + in: query + description: Type of the identity outliers snapshot to filter on + required: false + example: LOW_SIMILARITY + schema: + type: string + enum: + - LOW_SIMILARITY + - STRUCTURAL + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Succeeded. Returns list of objects. Each object is a summary to give high level statistics/counts of outliers. + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/LatestOutlierSummary.yaml + '202': + $ref: ../responses/202.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: [iai:outliers:read, iai:outliers:manage] + - applicationAuth: [iai:outliers:read, iai:outliers:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + - REPORT_ADMIN \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/outlier-summaries.yaml b/static/api-specs/idn/v2025/paths/outlier-summaries.yaml new file mode 100644 index 000000000..77e685362 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/outlier-summaries.yaml @@ -0,0 +1,87 @@ +get: + operationId: getIdentityOutlierSnapshots + tags: + - IAI Outliers + summary: IAI Identity Outliers Summary + description: >- + This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. + parameters: + - $ref: ../parameters/limit.yaml + - $ref: ../parameters/offset.yaml + - name: type + in: query + description: Type of the identity outliers snapshot to filter on + required: false + example: LOW_SIMILARITY + schema: + type: string + enum: + - LOW_SIMILARITY + - STRUCTURAL + - in: query + name: filters + schema: + type: string + description: >- + 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: + + + **snapshotDate**: *ge, le* + example: snapshotDate ge "2022-02-07T20:13:29.356648026Z" + required: false + - in: query + name: sorters + schema: + type: string + format: comma-separated + description: >- + Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **snapshotDate** + example: snapshotDate + required: false + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Succeeded. Returns list of objects. Each object is a summary to + give high level statistics/counts of outliers + headers: + X-Total-Count: + description: The total result count. + schema: + type: integer + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/OutlierSummary.yaml + '202': + $ref: ../responses/202.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: [iai:outliers:read, iai:outliers:manage] + - applicationAuth: [iai:outliers:read, iai:outliers:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + - REPORT_ADMIN \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/outliers-bulk-outlier-detection.yaml b/static/api-specs/idn/v2025/paths/outliers-bulk-outlier-detection.yaml new file mode 100644 index 000000000..187f79221 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/outliers-bulk-outlier-detection.yaml @@ -0,0 +1,28 @@ +post: + operationId: bulkOutlierDetection + tags: + - IAI Outliers + summary: IAI Identity Outliers + description: >- + This API receives a list of identities (and metadata about the identities) that IAI defines as outliers + + Requires authorization scope of 'iai:outliers-management:detect' + requestBody: + description: Contains list of identities classified as outliers, the time the outlier detection ran, and a state to give metadata about why an outlier is an outlier + content: + application/json: + schema: + $ref: '../schemas/OutliersBulkDetectionRequest.yaml' + responses: + '202': + $ref: '../responses/202.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/outliers-contributing-feature-access-items.yaml b/static/api-specs/idn/v2025/paths/outliers-contributing-feature-access-items.yaml new file mode 100644 index 000000000..42df0db89 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/outliers-contributing-feature-access-items.yaml @@ -0,0 +1,89 @@ +get: + operationId: listOutliersContributingFeatureAccessItems + tags: + - IAI Outliers + summary: Gets a list of access items associated with each identity outlier contributing feature + description: | + This API returns a list of the enriched access items associated with each feature filtered by the access item type. + + The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare. + parameters: + - $ref: ../parameters/limit.yaml + - $ref: ../parameters/offset.yaml + - $ref: ../parameters/count.yaml + - in: path + name: outlierId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getIdentityOutliers + description: The outlier id + example: 2c918085842e69ae018432d22ccb212f + - in: path + name: contributingFeatureName + schema: + type: string + enum: + - radical_entitlement_count + - entitlement_count + - max_jaccard_similarity + - mean_max_bundle_concurrency + - single_entitlement_bundle_count + - peerless_score + required: true + description: The name of contributing feature + example: entitlement_count + - in: query + name: accessType + required: false + schema: + type: string + description: The type of access item for the identity outlier contributing feature. If not provided, it returns all. + example: ENTITLEMENT + - in: query + name: sorters + required: false + schema: + type: string + format: comma-separated + example: displayName + description: >- + Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **displayName** + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: The list of access items. + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/OutliersContributingFeatureAccessItems.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: [iai:outliers:read, iai:outliers:manage] + - applicationAuth: [iai:outliers:read, iai:outliers:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + - REPORT_ADMIN diff --git a/static/api-specs/idn/v2025/paths/outliers-contributing-features.yaml b/static/api-specs/idn/v2025/paths/outliers-contributing-features.yaml new file mode 100644 index 000000000..dbc261e17 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/outliers-contributing-features.yaml @@ -0,0 +1,84 @@ +get: + operationId: getPeerGroupOutliersContributingFeatures + tags: + - IAI Outliers + summary: Get identity outlier's contibuting features + description: | + This API returns a list of contributing feature objects for a single outlier. + + The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object. + parameters: + - $ref: ../parameters/limit.yaml + - $ref: ../parameters/offset.yaml + - $ref: ../parameters/count.yaml + - name: include-translation-messages + in: query + description: Whether or not to include translation messages object in returned response + required: false + schema: + type: string + example: include-translation-messages= + - in: path + example: 2c918085842e69ae018432d22ccb212f + name: outlierId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getIdentityOutliers + description: The outlier id + - in: query + name: sorters + required: false + schema: + type: string + format: comma-separated + example: importance + description: >- + Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **importance** + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Succeeded. Returns list of objects. Each object contains a feature and metadata about that feature. + headers: + X-Total-Count: + description: The total result count. + schema: + type: integer + accept-language: + description: The locale to use for translations for displayName and description text + schema: + type: string + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/OutlierContributingFeature.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: [iai:outliers:read, iai:outliers:manage] + - applicationAuth: [iai:outliers:read, iai:outliers:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + - REPORT_ADMIN diff --git a/static/api-specs/idn/v2025/paths/outliers-export.yaml b/static/api-specs/idn/v2025/paths/outliers-export.yaml new file mode 100644 index 000000000..cfba42a6b --- /dev/null +++ b/static/api-specs/idn/v2025/paths/outliers-export.yaml @@ -0,0 +1,52 @@ +get: + operationId: exportOutliersZip + tags: + - IAI Outliers + summary: IAI Identity Outliers Export + description: | + This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. + + Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes). + parameters: + - name: type + in: query + description: Type of the identity outliers snapshot to filter on + required: false + example: LOW_SIMILARITY + schema: + type: string + enum: + - LOW_SIMILARITY + - STRUCTURAL + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Succeeded. Returns zip of two CSVs to download. One CSV for ignored outliers and the other for non-ignored outliers. + content: + application/zip: + schema: + type: string + format: binary + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: [iai:outliers:read, iai:outliers:manage] + - applicationAuth: [iai:outliers:read, iai:outliers:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + - REPORT_ADMIN diff --git a/static/api-specs/idn/v2025/paths/outliers-ignore.yaml b/static/api-specs/idn/v2025/paths/outliers-ignore.yaml new file mode 100644 index 000000000..2e0cd5358 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/outliers-ignore.yaml @@ -0,0 +1,45 @@ +post: + operationId: ignoreIdentityOutliers + tags: + - IAI Outliers + summary: IAI Identity Outliers Ignore + description: >- + This API receives a list of identity IDs in the request, changes the outliers to be ignored. + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + type: string + description: List of identity IDs to ignore from outlier listing + example: ['897ef96559df40e1baa6bae6b53e7340', '2c918085837fbfb4018384420dac60c3'] + responses: + '204': + $ref: ../responses/204.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + security: + - userAuth: [iai:outliers:manage] + - applicationAuth: [iai:outliers:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + - REPORT_ADMIN diff --git a/static/api-specs/idn/v2025/paths/outliers-unignore.yaml b/static/api-specs/idn/v2025/paths/outliers-unignore.yaml new file mode 100644 index 000000000..04a72ebea --- /dev/null +++ b/static/api-specs/idn/v2025/paths/outliers-unignore.yaml @@ -0,0 +1,45 @@ +post: + operationId: unIgnoreIdentityOutliers + tags: + - IAI Outliers + summary: IAI Identity Outliers Unignore + description: >- + This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + type: string + description: List of identity IDs to un-ignore from outlier listing + example: ['897ef96559df40e1baa6bae6b53e7340', '2c918085837fbfb4018384420dac60c3'] + responses: + '204': + $ref: ../responses/204.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + security: + - userAuth: [iai:outliers:manage] + - applicationAuth: [iai:outliers:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + - REPORT_ADMIN diff --git a/static/api-specs/idn/v2025/paths/outliers.yaml b/static/api-specs/idn/v2025/paths/outliers.yaml new file mode 100644 index 000000000..1a6a3d8a3 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/outliers.yaml @@ -0,0 +1,97 @@ +get: + operationId: getIdentityOutliers + tags: + - IAI Outliers + summary: IAI Get Identity Outliers + description: >- + This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information. + parameters: + - $ref: ../parameters/limit.yaml + - $ref: ../parameters/offset.yaml + - $ref: ../parameters/count.yaml + - name: type + in: query + description: Type of the identity outliers snapshot to filter on + required: false + schema: + type: string + enum: + - LOW_SIMILARITY + - STRUCTURAL + example: LOW_SIMILARITY + - in: query + name: filters + required: false + schema: + type: string + description: >- + 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: + + + **attributes**: *eq, sw, co, in* + + + **firstDetectionDate**: *ge, le* + + + **certStatus**: *eq* + + + **ignored**: *eq* + + + **score**: *ge, le* + example: attributes.displayName sw "John" and certStatus eq "false" + - in: query + name: sorters + required: false + schema: + type: string + format: comma-separated + description: >- + Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **firstDetectionDate, attributes, score** + example: attributes.displayName,firstDetectionDate,-score + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Succeeded. Returns list of objects. Each object contains information about outliers. + headers: + X-Total-Count: + description: The total result count. + schema: + type: integer + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/Outlier.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: [iai:outliers:read, iai:outliers:manage] + - applicationAuth: [iai:outliers:read, iai:outliers:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + - REPORT_ADMIN diff --git a/static/api-specs/idn/v2025/paths/password-change-status.yaml b/static/api-specs/idn/v2025/paths/password-change-status.yaml new file mode 100644 index 000000000..6b5969dfa --- /dev/null +++ b/static/api-specs/idn/v2025/paths/password-change-status.yaml @@ -0,0 +1,41 @@ +get: + operationId: getPasswordChangeStatus + tags: + - Password Management + summary: Get Password Change Request Status + security: + - userAuth: [] + - applicationAuth: [] + x-sailpoint-userLevels: + - ORG_ADMIN + description: >- + This API returns the status of a password change request. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: setPassword + example: 089899f13a8f4da7824996191587bab9 + description: >- + Password change request ID + responses: + '200': + description: Status of the password change request + content: + application/json: + schema: + $ref: '../schemas/PasswordStatus.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/password-dictionary.yaml b/static/api-specs/idn/v2025/paths/password-dictionary.yaml new file mode 100644 index 000000000..c35e3d46c --- /dev/null +++ b/static/api-specs/idn/v2025/paths/password-dictionary.yaml @@ -0,0 +1,155 @@ +get: + operationId: getPasswordDictionary + tags: + - Password Dictionary + summary: Get Password Dictionary + description: >- + This gets password dictionary for the organization. + + The password dictionary file can contain lines that are: + + 1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing + + 2. empty lines + + 3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines + + 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; + maximum length of the line is 128 Unicode codepoints + + + Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). + Password dict file must contain UTF-8 characters only. + + # Sample password text file + + + ``` + + + # Password dictionary small test file + + + locale=en_US + + + # Password dictionary prohibited words + + + qwerty + + abcd + + aaaaa + + password + + qazxsws + + + ``` + security: + - userAuth: [idn:password-dictionary-management:read] + x-sailpoint-userLevels: + - ORG_ADMIN + responses: + '200': + description: A password dictionary response + content: + text/plain: + schema: + type: string + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +put: + operationId: putPasswordDictionary + tags: + - Password Dictionary + summary: Update Password Dictionary + description: >- + This updates password dictionary for the organization. + + The password dictionary file can contain lines that are: + + 1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing + + 2. empty lines + + 3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines + + 4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; + maximum length of the line is 128 Unicode codepoints + + + Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). + Password dict file must contain UTF-8 characters only. + + # Sample password text file + + + ``` + + + # Password dictionary small test file + + + locale=en_US + + + # Password dictionary prohibited words + + + qwerty + + abcd + + aaaaa + + password + + qazxsws + + + ``` + security: + - userAuth: [idn:password-dictionary:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + requestBody: + required: true + description: The password dictionary file to be uploaded. + content: + multipart/form-data: + schema: + type: object + properties: + file: + type: string + format: binary + responses: + '200': + description: Successfully updated. + '201': + description: Created. + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/password-org-config.yaml b/static/api-specs/idn/v2025/paths/password-org-config.yaml new file mode 100644 index 000000000..7b841cced --- /dev/null +++ b/static/api-specs/idn/v2025/paths/password-org-config.yaml @@ -0,0 +1,133 @@ +get: + operationId: getPasswordOrgConfig + tags: + - Password Configuration + summary: Get Password Org Config + description: >- + This API returns the password org config . + Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:read' + security: + - userAuth: ['idn:password-org-config:read'] + responses: + '200': + description: Reference to the password org config. + content: + application/json: + schema: + $ref: '../schemas/PasswordOrgConfig.yaml' + example: + { + "customInstructionsEnabled": true, + "digitTokenDurationMinutes": 9, + "digitTokenEnabled": false, + "digitTokenLength": 6 + } + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +put: + operationId: putPasswordOrgConfig + tags: + - Password Configuration + summary: Update Password Org Config + description: >- + This API updates the password org config for specified fields. Other fields will keep original value. + + You must set the `customInstructionsEnabled` field to "true" to be able to use custom password instructions. + + Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' + security: + - userAuth: ['idn:password-org-config:write'] + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/PasswordOrgConfig.yaml' + example: + { + "digitTokenEnabled": true, + "digitTokenDurationMinutes": 12 + } + responses: + '200': + description: Reference to the password org config. + content: + application/json: + schema: + $ref: '../schemas/PasswordOrgConfig.yaml' + example: + { + "customInstructionsEnabled": true, + "digitTokenDurationMinutes": 12, + "digitTokenEnabled": true, + "digitTokenLength": 6 + } + + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +post: + operationId: createPasswordOrgConfig + tags: + - Password Configuration + summary: Create Password Org Config + description: >- + This API creates the password org config. Unspecified fields will use default value. + + To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to "true". + + Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' + security: + - userAuth: [ 'idn:password-org-config:write' ] + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/PasswordOrgConfig.yaml' + example: + { + "customInstructionsEnabled": true, + "digitTokenEnabled": true, + "digitTokenDurationMinutes": 12, + "digitTokenLength": 9 + } + responses: + '200': + description: Reference to the password org config. + content: + application/json: + schema: + $ref: '../schemas/PasswordOrgConfig.yaml' + example: + { + "customInstructionsEnabled": true, + "digitTokenDurationMinutes": 9, + "digitTokenEnabled": true, + "digitTokenLength": 12 + } + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/password-policies.yaml b/static/api-specs/idn/v2025/paths/password-policies.yaml new file mode 100644 index 000000000..24556ee0c --- /dev/null +++ b/static/api-specs/idn/v2025/paths/password-policies.yaml @@ -0,0 +1,167 @@ +post: + operationId: createPasswordPolicy + tags: + - Password Policies + summary: Create Password Policy + description: >- + This API creates the specified password policy. + security: + - userAuth: ['idn:password-policy:write'] + x-sailpoint-userLevels: + - ORG_ADMIN + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/PasswordPolicyV3Dto.yaml' + example: + { + "description": "New Password Policy with high requirements to password complexity.", + "id": null, + "name": "High security Password Policy", + "dateCreated": 1639056206564, + "lastUpdated": 1662385430753, + "firstExpirationReminder": 90, + "accountIdMinWordLength": 3, + "accountNameMinWordLength": 3, + "maxLength": 0, + "maxRepeatedChars": 4, + "minAlpha": 1, + "minCharacterTypes": -1, + "minLength": 8, + "minLower": 0, + "minNumeric": 1, + "minSpecial": 0, + "minUpper": 0, + "passwordExpiration": 90, + "defaultPolicy": false, + "enablePasswdExpiration": false, + "requireStrongAuthn": false, + "requireStrongAuthOffNetwork": false, + "requireStrongAuthUntrustedGeographies": false, + "useAccountAttributes": false, + "useDictionary": false, + "useIdentityAttributes": false, + "validateAgainstAccountId": true, + "validateAgainstAccountName": true, + "sourceIds": ["2c91808382ffee0b01830de154f14034","2c91808582ffee0c01830de36511405f" ] + } + responses: + '200': + description: Reference to the password policy. + content: + application/json: + schema: + $ref: '../schemas/PasswordPolicyV3Dto.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +get: + operationId: listPasswordPolicies + tags: + - Password Policies + summary: List Password Policies + description: >- + This gets list of all Password Policies. + + Requires role of ORG_ADMIN + security: + - userAuth: ['idn:password-policy:read'] + parameters: + - $ref: '../parameters/limit.yaml' + - $ref: '../parameters/offset.yaml' + - $ref: '../parameters/count.yaml' + responses: + '200': + description: List of all Password Policies. + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/PasswordPolicyV3Dto.yaml' + example: + [ + { + "description": "Example Password Policy", + "id": "2c91808e7d976f3b017d9f5ceae440c8", + "name": "Example PP", + "dateCreated": 1639056206564, + "lastUpdated": 1662385430753, + "firstExpirationReminder": 90, + "accountIdMinWordLength": 3, + "accountNameMinWordLength": 3, + "maxLength": 0, + "maxRepeatedChars": 4, + "minAlpha": 1, + "minCharacterTypes": -1, + "minLength": 8, + "minLower": 0, + "minNumeric": 1, + "minSpecial": 0, + "minUpper": 0, + "passwordExpiration": 90, + "defaultPolicy": false, + "enablePasswdExpiration": false, + "requireStrongAuthn": false, + "requireStrongAuthOffNetwork": false, + "requireStrongAuthUntrustedGeographies": false, + "useAccountAttributes": false, + "useDictionary": false, + "useIdentityAttributes": false, + "validateAgainstAccountId": true, + "validateAgainstAccountName": true, + "sourceIds": ["2c91808382ffee0b01830de154f14034","2c91808582ffee0c01830de36511405f" ] + }, + { + "description": null, + "id": "2c91808780b8b8430180ff7a093f3bf2", + "name": "Password Policy 1 test", + "dateCreated": 1653553629503, + "lastUpdated": null, + "firstExpirationReminder": null, + "accountIdMinWordLength": -1, + "accountNameMinWordLength": -1, + "maxLength": 0, + "maxRepeatedChars": -1, + "minAlpha": 1, + "minCharacterTypes": -1, + "minLength": 8, + "minLower": 0, + "minNumeric": 1, + "minSpecial": 0, + "minUpper": 0, + "passwordExpiration": 90, + "defaultPolicy": false, + "enablePasswdExpiration": false, + "requireStrongAuthn": false, + "requireStrongAuthOffNetwork": false, + "requireStrongAuthUntrustedGeographies": false, + "useAccountAttributes": false, + "useDictionary": false, + "useIdentityAttributes": true, + "validateAgainstAccountId": false, + "validateAgainstAccountName": false, + "sourceIds": [ ] + } + ] + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/password-policy.yaml b/static/api-specs/idn/v2025/paths/password-policy.yaml new file mode 100644 index 000000000..cda69a0fc --- /dev/null +++ b/static/api-specs/idn/v2025/paths/password-policy.yaml @@ -0,0 +1,215 @@ +get: + operationId: getPasswordPolicyById + tags: + - Password Policies + summary: Get Password Policy by ID + description: >- + This API returns the password policy for the specified ID. + security: + - userAuth: ['idn:password-policy:read'] + x-sailpoint-userLevels: + - ORG_ADMIN + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listPasswordPolicies + description: The ID of password policy to retrieve. + example: ff808081838d9e9d01838da6a03e0005 + responses: + '200': + description: Reference to the password policy. + content: + application/json: + schema: + $ref: '../schemas/PasswordPolicyV3Dto.yaml' + example: + { + "description": "Default Password Policy", + "id": "2c91808e7d976f3b017d9f5ceae440c8", + "name": "Example PP", + "dateCreated": 1639056206564, + "lastUpdated": 1662385430753, + "firstExpirationReminder": 90, + "accountIdMinWordLength": 3, + "accountNameMinWordLength": 3, + "maxLength": 0, + "maxRepeatedChars": 4, + "minAlpha": 1, + "minCharacterTypes": -1, + "minLength": 8, + "minLower": 0, + "minNumeric": 1, + "minSpecial": 0, + "minUpper": 0, + "passwordExpiration": 90, + "defaultPolicy": true, + "enablePasswdExpiration": false, + "requireStrongAuthn": false, + "requireStrongAuthOffNetwork": false, + "requireStrongAuthUntrustedGeographies": false, + "useAccountAttributes": false, + "useDictionary": false, + "useIdentityAttributes": false, + "validateAgainstAccountId": true, + "validateAgainstAccountName": true, + "sourceIds": ["2c91808382ffee0b01830de154f14034","2c91808582ffee0c01830de36511405f" ] + } + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +put: + operationId: setPasswordPolicy + tags: + - Password Policies + summary: Update Password Policy by ID + description: >- + This API updates the specified password policy. + security: + - userAuth: ['idn:password-policy:write'] + x-sailpoint-userLevels: + - ORG_ADMIN + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listPasswordPolicies + description: The ID of password policy to update. + example: ff808081838d9e9d01838da6a03e0007 + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/PasswordPolicyV3Dto.yaml' + example: + { + "description": "Password Policy after update.", + "id": "2c91808e7d976f3b017d9f5ceae440c8", + "name": "Improved Password Policy", + "dateCreated": 1639056206564, + "lastUpdated": 1662385430753, + "firstExpirationReminder": 90, + "accountIdMinWordLength": 3, + "accountNameMinWordLength": 3, + "maxLength": 0, + "maxRepeatedChars": 4, + "minAlpha": 1, + "minCharacterTypes": -1, + "minLength": 8, + "minLower": 0, + "minNumeric": 1, + "minSpecial": 0, + "minUpper": 0, + "passwordExpiration": 90, + "defaultPolicy": false, + "enablePasswdExpiration": false, + "requireStrongAuthn": false, + "requireStrongAuthOffNetwork": false, + "requireStrongAuthUntrustedGeographies": false, + "useAccountAttributes": false, + "useDictionary": false, + "useIdentityAttributes": false, + "validateAgainstAccountId": true, + "validateAgainstAccountName": true, + "sourceIds": ["2c91808382ffee0b01830de154f14034","2c91808582ffee0c01830de36511405f" ] + } + responses: + '200': + description: Reference to the password policy. + content: + application/json: + schema: + $ref: '../schemas/PasswordPolicyV3Dto.yaml' + example: + { + "description": "Password Policy after update.", + "id": "2c91808e7d976f3b017d9f5ceae440c8", + "name": "Improved Password Policy", + "dateCreated": 1639056206564, + "lastUpdated": 1662385430753, + "firstExpirationReminder": 90, + "accountIdMinWordLength": 3, + "accountNameMinWordLength": 3, + "maxLength": 0, + "maxRepeatedChars": 4, + "minAlpha": 1, + "minCharacterTypes": -1, + "minLength": 8, + "minLower": 0, + "minNumeric": 1, + "minSpecial": 0, + "minUpper": 0, + "passwordExpiration": 90, + "defaultPolicy": false, + "enablePasswdExpiration": false, + "requireStrongAuthn": false, + "requireStrongAuthOffNetwork": false, + "requireStrongAuthUntrustedGeographies": false, + "useAccountAttributes": false, + "useDictionary": false, + "useIdentityAttributes": false, + "validateAgainstAccountId": true, + "validateAgainstAccountName": true, + "sourceIds": ["2c91808382ffee0b01830de154f14034","2c91808582ffee0c01830de36511405f" ] + } + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +delete: + operationId: deletePasswordPolicy + tags: + - Password Policies + summary: Delete Password Policy by ID + description: >- + This API deletes the specified password policy. + security: + - userAuth: ['idn:password-policy:write'] + x-sailpoint-userLevels: + - ORG_ADMIN + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listPasswordPolicies + description: The ID of password policy to delete. + example: ff808081838d9e9d01838da6a03e0002 + responses: + '204': + $ref: '../responses/204.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/password-reset-digit-token.yaml b/static/api-specs/idn/v2025/paths/password-reset-digit-token.yaml new file mode 100644 index 000000000..21d23ff01 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/password-reset-digit-token.yaml @@ -0,0 +1,48 @@ +post: + operationId: createDigitToken + security: + - userAuth: [ idn:password-digit-token:create ] + summary: Generate a digit token + tags: + - Password Management + description: This API is used to generate a digit token for password management. + Requires authorization scope of "idn:password-digit-token:create". + requestBody: + required: true + content: + application/json: + schema: + $ref: ../schemas/PasswordDigitTokenReset.yaml + example: + userId: Abby.Smith + length: 8 + durationMinutes: 5 + responses: + '200': + description: The digit token for password management. + content: + application/json: + schema: + $ref: ../schemas/PasswordDigitToken.yaml + example: + digitToken: 09087713 + requestId: e1267ecd-fcd9-4c73-9c55-12555efad136 + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true diff --git a/static/api-specs/idn/v2025/paths/password-sync-group.yaml b/static/api-specs/idn/v2025/paths/password-sync-group.yaml new file mode 100644 index 000000000..675c89322 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/password-sync-group.yaml @@ -0,0 +1,139 @@ +get: + operationId: getPasswordSyncGroup + tags: + - Password Sync Groups + summary: Get Password Sync Group by ID + description: >- + This API returns the sync group for the specified ID. + security: + - userAuth: ['idn:password-sync-group-management:read'] + x-sailpoint-userLevels: + - ORG_ADMIN + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getPasswordSyncGroups + description: The ID of password sync group to retrieve. + example: 6881f631-3bd5-4213-9c75-8e05cc3e35dd + responses: + '200': + description: Reference to the password sync group. + content: + application/json: + schema: + $ref: '../schemas/PasswordSyncGroup.yaml' + example: + { + "id": "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "name": "Password Sync Group 1", + "passwordPolicyId": "2c91808d744ba0ce01746f93b6204501", + "sourceIds": ["2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500"] + } + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +put: + operationId: updatePasswordSyncGroup + tags: + - Password Sync Groups + summary: Update Password Sync Group by ID + description: >- + This API updates the specified password sync group. + security: + - userAuth: ['idn:password-sync-group-management:write'] + x-sailpoint-userLevels: + - ORG_ADMIN + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getPasswordSyncGroups + description: The ID of password sync group to update. + example: 6881f631-3bd5-4213-9c75-8e05cc3e35dd + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/PasswordSyncGroup.yaml' + example: + { + "id": "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "name": "Password Sync Group 2", + "passwordPolicyId": "2c91808d744ba0ce01746f93b6204501", + "sourceIds": ["2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500"] + } + responses: + '200': + description: Reference to the password sync group. + content: + application/json: + schema: + $ref: '../schemas/PasswordSyncGroup.yaml' + example: + { + "id": "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "name": "Password Sync Group 2", + "passwordPolicyId": "2c91808d744ba0ce01746f93b6204501", + "sourceIds": ["2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500"] + } + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +delete: + operationId: deletePasswordSyncGroup + tags: + - Password Sync Groups + summary: Delete Password Sync Group by ID + description: >- + This API deletes the specified password sync group. + security: + - userAuth: ['idn:password-sync-group-management:write'] + x-sailpoint-userLevels: + - ORG_ADMIN + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getPasswordSyncGroups + description: The ID of password sync group to delete. + example: 6881f631-3bd5-4213-9c75-8e05cc3e35dd + responses: + '204': + $ref: '../responses/204.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + diff --git a/static/api-specs/idn/v2025/paths/password-sync-groups.yaml b/static/api-specs/idn/v2025/paths/password-sync-groups.yaml new file mode 100644 index 000000000..2a57a874c --- /dev/null +++ b/static/api-specs/idn/v2025/paths/password-sync-groups.yaml @@ -0,0 +1,82 @@ +get: + operationId: getPasswordSyncGroups + tags: + - Password Sync Groups + summary: Get Password Sync Group List + description: >- + This API returns a list of password sync groups. + security: + - userAuth: ['idn:password-sync-group-management:read'] + x-sailpoint-userLevels: + - ORG_ADMIN + parameters: + - $ref: '../parameters/limit.yaml' + - $ref: '../parameters/offset.yaml' + - $ref: '../parameters/count.yaml' + responses: + '200': + description: A list of password sync groups. + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/PasswordSyncGroup.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + "429": + $ref: "../responses/429.yaml" + '500': + $ref: '../responses/500.yaml' +post: + operationId: createPasswordSyncGroup + tags: + - Password Sync Groups + summary: Create Password Sync Group + description: >- + This API creates a password sync group based on the specifications provided. + security: + - userAuth: ['idn:password-sync-group-management:write'] + x-sailpoint-userLevels: + - ORG_ADMIN + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/PasswordSyncGroup.yaml' + example: + { + "name": "Password Sync Group 2", + "passwordPolicyId": "2c91808d744ba0ce01746f93b6204501", + "sourceIds": ["2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500"] + } + responses: + '200': + description: Reference to the password sync group. + content: + application/json: + schema: + $ref: '../schemas/PasswordSyncGroup.yaml' + example: + { + "id": "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "name": "Password Sync Group 2", + "passwordPolicyId": "2c91808d744ba0ce01746f93b6204501", + "sourceIds": ["2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500"] + } + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + diff --git a/static/api-specs/idn/v2025/paths/peer-group-strategies.yaml b/static/api-specs/idn/v2025/paths/peer-group-strategies.yaml new file mode 100644 index 000000000..2f301f054 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/peer-group-strategies.yaml @@ -0,0 +1,53 @@ +get: + operationId: getPeerGroupOutliers + tags: + - IAI Peer Group Strategies + summary: Identity Outliers List + deprecated: true + description: '-- Deprecated : See ''IAI Outliers'' This API will be used by Identity + Governance systems to identify identities that are not included in an organization''s + peer groups. By default, 250 identities are returned. You can specify between + 1 and 1000 number of identities that can be returned.' + parameters: + - in: path + name: strategy + schema: + type: string + enum: + - entitlement + required: true + description: The strategy used to create peer groups. Currently, 'entitlement' + is supported. + example: entitlement + - $ref: ../parameters/limit.yaml + - $ref: ../parameters/offset.yaml + - $ref: ../parameters/count.yaml + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: List of identities that are not included in peer groups. + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/PeerGroupMember.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: [] diff --git a/static/api-specs/idn/v2025/paths/pending-access-request-approvals.yaml b/static/api-specs/idn/v2025/paths/pending-access-request-approvals.yaml new file mode 100644 index 000000000..efa716a28 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/pending-access-request-approvals.yaml @@ -0,0 +1,82 @@ +get: + operationId: listPendingApprovals + security: + - userAuth: [ idn:access-request-approvals:read ] + x-sailpoint-userLevels: + - ORG_ADMIN + summary: Pending Access Request Approvals List + tags: + - Access Request Approvals + description: >- + This endpoint returns a list of pending approvals. + See "owner-id" query parameter below for authorization info. + parameters: + - in: query + name: owner-id + schema: + type: string + description: >- + If present, the value returns only pending approvals for the specified identity. + * ORG_ADMIN users can call this with any identity ID value. + * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. + * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. + example: 2c91808568c529c60168cca6f90c1313 + + required: false + - $ref: '../parameters/limit.yaml' + - $ref: '../parameters/offset.yaml' + - $ref: '../parameters/count.yaml' + - in: query + name: filters + required: false + schema: + type: string + description: >- + Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) + + + Filtering is supported for the following fields and operators: + + + **id**: *eq, in* + + + **requestedFor.id**: *eq, in* + + + **modified**: *gt, lt, ge, le, eq, in* + + + **accessRequestId**: *eq, in* + example: id eq "2c91808568c529c60168cca6f90c1313" + - in: query + name: sorters + required: false + schema: + type: string + format: comma-separated + description: >- + Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **created, modified** + example: modified + responses: + '200': + description: List of Pending Approvals. + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/PendingApproval.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/personal-access-token.yaml b/static/api-specs/idn/v2025/paths/personal-access-token.yaml new file mode 100644 index 000000000..6121c6296 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/personal-access-token.yaml @@ -0,0 +1,95 @@ +patch: + operationId: patchPersonalAccessToken + security: + - userAuth: [sp:my-personal-access-tokens:manage] + tags: + - Personal Access Tokens + summary: Patch Personal Access Token + description: >- + This performs a targeted update to the field(s) of a Personal Access Token. + + Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listPersonalAccessTokens + description: The Personal Access Token id + example: ef38f94347e94562b5bb8424a56397d8 + requestBody: + required: true + description: | + A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + The following fields are patchable: + * name + * scope + content: + application/json-patch+json: + schema: + type: array + items: + $ref: '../schemas/JsonPatchOperation.yaml' + example: + - op: "replace" + path: "/name" + value: "New name" + - op: "replace" + path: "/scope" + value: ["sp:scopes:all"] + responses: + '200': + description: >- + Indicates the PATCH operation succeeded, and returns the PAT's new representation. + content: + application/json: + schema: + $ref: '../schemas/GetPersonalAccessTokenResponse.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +delete: + operationId: deletePersonalAccessToken + security: + - userAuth: [sp:my-personal-access-tokens:manage, sp:all-personal-access-tokens:manage] + tags: + - Personal Access Tokens + summary: Delete Personal Access Token + description: >- + This deletes a personal access token. + + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listPersonalAccessTokens + description: The personal access token id + example: ef38f94347e94562b5bb8424a56397d8 + responses: + "204": + description: No content. + "400": + $ref: "../responses/400.yaml" + "401": + $ref: "../responses/401.yaml" + "403": + $ref: "../responses/403.yaml" + "404": + $ref: "../responses/404.yaml" + "429": + $ref: "../responses/429.yaml" + "500": + $ref: "../responses/500.yaml" diff --git a/static/api-specs/idn/v2025/paths/personal-access-tokens.yaml b/static/api-specs/idn/v2025/paths/personal-access-tokens.yaml new file mode 100644 index 000000000..216c38d44 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/personal-access-tokens.yaml @@ -0,0 +1,100 @@ +get: + operationId: listPersonalAccessTokens + security: + - userAuth: [sp:my-personal-access-tokens:read, sp:my-personal-access-tokens:manage, sp:all-personal-access-tokens:read, sp:all-personal-access-tokens:manage] + tags: + - Personal Access Tokens + summary: List Personal Access Tokens + description: >- + This gets a collection of personal access tokens associated with the optional `owner-id`. + query parameter. If the `owner-id` query parameter is omitted, all personal access tokens + for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right. + + parameters: + - in: query + name: owner-id + description: >- + The identity ID of the owner whose personal access tokens should be listed. + If "me", the caller should have the following right: 'idn:my-personal-access-tokens:read' + + If an actual owner ID or if the `owner-id` parameter is omitted in the request, + the caller should have the following right: 'idn:all-personal-access-tokens:read'. + + If the caller has the following right, then managed personal access tokens associated with `owner-id` + will be retrieved: 'idn:managed-personal-access-tokens:read' + required: false + schema: + type: string + default: null + example: 2c9180867b50d088017b554662fb281e + - in: query + name: filters + required: false + schema: + type: string + description: >- + 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: + + + **lastUsed**: *le, isnull* + example: lastUsed le 2023-02-05T10:59:27.214Z + responses: + "200": + description: List of personal access tokens. + content: + application/json: + schema: + type: array + items: + $ref: "../schemas/GetPersonalAccessTokenResponse.yaml" + "400": + $ref: "../responses/400.yaml" + "401": + $ref: "../responses/401.yaml" + "403": + $ref: "../responses/403.yaml" + "429": + $ref: "../responses/429.yaml" + "500": + $ref: "../responses/500.yaml" +post: + operationId: createPersonalAccessToken + security: + - userAuth: [ sp:my-personal-access-tokens:manage, sp:all-personal-access-tokens:manage ] + tags: + - Personal Access Tokens + summary: Create Personal Access Token + description: >- + This creates a personal access token. + + requestBody: + description: Name and scope of personal access token. + required: true + content: + application/json: + schema: + $ref: "../schemas/CreatePersonalAccessTokenRequest.yaml" + responses: + "200": + description: + Created. Note - this is the only time Personal Access Tokens' secret + attribute will be displayed. + content: + application/json: + schema: + $ref: "../schemas/CreatePersonalAccessTokenResponse.yaml" + "400": + $ref: "../responses/400.yaml" + "401": + $ref: "../responses/401.yaml" + "403": + $ref: "../responses/403.yaml" + "429": + $ref: "../responses/429.yaml" + "500": + $ref: "../responses/500.yaml" diff --git a/static/api-specs/idn/v2025/paths/provisioning-policies-bulk-update.yaml b/static/api-specs/idn/v2025/paths/provisioning-policies-bulk-update.yaml new file mode 100644 index 000000000..8d0c5dd3c --- /dev/null +++ b/static/api-specs/idn/v2025/paths/provisioning-policies-bulk-update.yaml @@ -0,0 +1,51 @@ +post: + operationId: updateProvisioningPoliciesInBulk + tags: + - Sources + summary: Bulk Update Provisioning Policies + description: >- + This end-point updates a list of provisioning policies on the specified source in IdentityNow. + security: + - userAuth: [idn:provisioning-policy:manage] + - applicationAuth: [idn:provisioning-policy:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + parameters: + - in: path + name: sourceId + required: true + x-sailpoint-resource-operation-id: listSources + schema: + type: string + description: The Source id. + example: 2c9180835d191a86015d28455b4a2329 + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/ProvisioningPolicyDto.yaml' + responses: + '200': + description: >- + A list of the ProvisioningPolicyDto was successfully replaced. + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/ProvisioningPolicyDto.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/provisioning-policies.yaml b/static/api-specs/idn/v2025/paths/provisioning-policies.yaml new file mode 100644 index 000000000..4b434bce0 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/provisioning-policies.yaml @@ -0,0 +1,185 @@ +get: + operationId: listProvisioningPolicies + tags: + - Sources + summary: Lists ProvisioningPolicies + description: >- + This end-point lists all the ProvisioningPolicies in IdentityNow. + security: + - userAuth: [idn:provisioning-policy:read, idn:provisioning-policy:manage] + - applicationAuth: [idn:provisioning-policy:read, idn:provisioning-policy:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + parameters: + - in: path + name: sourceId + required: true + x-sailpoint-resource-operation-id: listSources + schema: + type: string + description: The Source id + example: 2c9180835d191a86015d28455b4a2329 + responses: + '200': + description: List of ProvisioningPolicyDto objects + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/ProvisioningPolicyDto.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +post: + operationId: createProvisioningPolicy + tags: + - Sources + summary: Create Provisioning Policy + description: >- + This API generates a create policy/template based on field value transforms. This API is intended for use when + setting up JDBC Provisioning type sources, but it will also work on other source types. + + Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. + + Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. + security: + - userAuth: [idn:provisioning-policy:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + parameters: + - in: path + name: sourceId + required: true + x-sailpoint-resource-operation-id: listSources + schema: + type: string + description: The Source id + example: 2c9180835d191a86015d28455b4a2329 + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/ProvisioningPolicyDto.yaml' + examples: + Create Account Provisioning Policy: + value: + name: Account + description: Account Provisioning Policy + usageType: CREATE + fields: [{ + "name": "displayName", + "transform": { + "type": "identityAttribute", + "attributes": { + "name": "displayName" + } + }, + "attributes": {}, + "isRequired": false, + "type": "string", + "isMultiValued": false + }, + { + "name": "distinguishedName", + "transform": { + "type": "usernameGenerator", + "attributes": { + "sourceCheck": true, + "patterns": [ + "CN=$fi $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com", + "CN=$fti $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com", + "CN=$fn $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com", + "CN=$fn$ln${uniqueCounter},OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com" + ], + "fn": { + "type": "identityAttribute", + "attributes": { + "name": "firstname" + } + }, + "ln": { + "type": "identityAttribute", + "attributes": { + "name": "lastname" + } + }, + "fi": { + "type": "substring", + "attributes": { + "input": { + "type": "identityAttribute", + "attributes": { + "name": "firstname" + } + }, + "begin": 0.0, + "end": 1.0 + } + }, + "fti": { + "type": "substring", + "attributes": { + "input": { + "type": "identityAttribute", + "attributes": { + "name": "firstname" + } + }, + "begin": 0.0, + "end": 2.0 + } + } + } + }, + "attributes": { + "cloudMaxUniqueChecks": "5", + "cloudMaxSize": "100", + "cloudRequired": "true" + }, + "isRequired": false, + "type": "", + "isMultiValued": false + }, + { + "name": "description", + "transform": { + "type": "static", + "attributes": { + "value": "" + } + }, + "attributes": {}, + "isRequired": false, + "type": "string", + "isMultiValued": false + }] + responses: + '201': + description: Created ProvisioningPolicyDto object + content: + application/json: + schema: + $ref: '../schemas/ProvisioningPolicyDto.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/provisioning-policy.yaml b/static/api-specs/idn/v2025/paths/provisioning-policy.yaml new file mode 100644 index 000000000..55b1b371a --- /dev/null +++ b/static/api-specs/idn/v2025/paths/provisioning-policy.yaml @@ -0,0 +1,304 @@ +get: + operationId: getProvisioningPolicy + tags: + - Sources + summary: Get Provisioning Policy by UsageType + description: >- + This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. + security: + - userAuth: [idn:provisioning-policy:read, idn:provisioning-policy-source:read, idn:provisioning-policy:manage, idn:provisioning-policy-source-admin-operations:manage] + - applicationAuth: [idn:provisioning-policy:read, idn:provisioning-policy-source:read, idn:provisioning-policy:manage, idn:provisioning-policy-source-admin-operations:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN + parameters: + - in: path + name: sourceId + required: true + x-sailpoint-resource-operation-id: listSources + schema: + type: string + description: The Source ID. + example: 2c9180835d191a86015d28455b4a2329 + - in: path + name: usageType + required: true + description: >- + The type of provisioning policy usage. + + In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. + Each usage type is considered a provisioning policy. + A source can have any number of these provisioning policies defined. + + These are the common usage types: + + CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. + + UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. + + ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. + + DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. + + You can use these four usage types for all your provisioning policy needs. + example: CREATE + schema: + $ref: '../schemas/UsageType.yaml' + responses: + '200': + description: The requested ProvisioningPolicyDto was successfully retrieved. + content: + application/json: + schema: + $ref: '../schemas/ProvisioningPolicyDto.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +put: + operationId: putProvisioningPolicy + tags: + - Sources + summary: Update Provisioning Policy by UsageType + description: >- + This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. + + Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. + + Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. + security: + - userAuth: [idn:provisioning-policy:manage, idn:provisioning-policy-source-admin-operations:manage] + - applicationAuth: [idn:provisioning-policy:manage, idn:provisioning-policy-source-admin-operations:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN + parameters: + - in: path + name: sourceId + required: true + x-sailpoint-resource-operation-id: listSources + schema: + type: string + description: The Source ID. + example: 2c9180835d191a86015d28455b4a2329 + - in: path + name: usageType + required: true + description: >- + The type of provisioning policy usage. + + In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. + Each usage type is considered a provisioning policy. + A source can have any number of these provisioning policies defined. + + These are the common usage types: + + CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. + + UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. + + ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. + + DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. + + You can use these four usage types for all your provisioning policy needs. + example: CREATE + schema: + $ref: '../schemas/UsageType.yaml' + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/ProvisioningPolicyDto.yaml' + responses: + '200': + description: The ProvisioningPolicyDto was successfully replaced. + content: + application/json: + schema: + $ref: '../schemas/ProvisioningPolicyDto.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +patch: + operationId: updateProvisioningPolicy + tags: + - Sources + summary: Partial update of Provisioning Policy + description: >- + This API selectively updates an existing Provisioning Policy using a JSONPatch payload. + + Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. + + Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. + security: + - userAuth: [idn:provisioning-policy:update] + - applicationAuth: [idn:provisioning-policy:update] + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN + parameters: + - in: path + name: sourceId + required: true + x-sailpoint-resource-operation-id: listSources + schema: + type: string + description: The Source id. + example: 2c9180835d191a86015d28455b4a2329 + - in: path + name: usageType + required: true + description: >- + The type of provisioning policy usage. + + In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. + Each usage type is considered a provisioning policy. + A source can have any number of these provisioning policies defined. + + These are the common usage types: + + CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. + + UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. + + ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. + + DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. + + You can use these four usage types for all your provisioning policy needs. + example: CREATE + schema: + $ref: '../schemas/UsageType.yaml' + requestBody: + required: true + description: The JSONPatch payload used to update the schema. + content: + application/json-patch+json: + schema: + type: array + items: + $ref: '../schemas/JsonPatchOperation.yaml' + examples: + add-field: + summary: Add a field to the beginning of the list + value: [ + { + "op": "add", + "path": "/fields/0", + "value": { + "name": "email", + "transform": { + "type": "identityAttribute", + "attributes": { + "name": "email" + } + }, + "attributes": {}, + "isRequired": false, + "type": "string", + "isMultiValued": false + } + } + ] + responses: + '200': + description: The ProvisioningPolicyDto was successfully updated. + content: + application/json: + schema: + $ref: '../schemas/ProvisioningPolicyDto.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +delete: + operationId: deleteProvisioningPolicy + tags: + - Sources + summary: Delete Provisioning Policy by UsageType + description: >- + Deletes the provisioning policy with the specified usage on an application. + security: + - userAuth: [idn:provisioning-policy:manage] + - applicationAuth: [idn:provisioning-policy:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + parameters: + - in: path + name: sourceId + required: true + x-sailpoint-resource-operation-id: listSources + schema: + type: string + description: The Source ID. + example: 2c9180835d191a86015d28455b4a2329 + - in: path + name: usageType + required: true + description: >- + The type of provisioning policy usage. + + In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. + Each usage type is considered a provisioning policy. + A source can have any number of these provisioning policies defined. + + These are the common usage types: + + CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. + + UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. + + ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. + + DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. + + You can use these four usage types for all your provisioning policy needs. + example: CREATE + schema: + $ref: '../schemas/UsageType.yaml' + responses: + '204': + $ref: '../responses/204.yaml' + description: The ProvisioningPolicyDto was successfully deleted. + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/public-identities-config.yaml b/static/api-specs/idn/v2025/paths/public-identities-config.yaml new file mode 100644 index 000000000..5a12ea9c8 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/public-identities-config.yaml @@ -0,0 +1,62 @@ +get: + operationId: getPublicIdentityConfig + tags: + - Public Identities Config + summary: Get the Public Identities Configuration + description: >- + Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. + security: + - userAuth: [] + x-sailpoint-userLevels: + - ORG_ADMIN + responses: + '200': + description: Request succeeded. + content: + application/json: + schema: + $ref: '../schemas/PublicIdentityConfig.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +put: + operationId: updatePublicIdentityConfig + tags: + - Public Identities Config + summary: Update the Public Identities Configuration + description: >- + Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. + security: + - userAuth: [] + x-sailpoint-userLevels: + - ORG_ADMIN + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/PublicIdentityConfig.yaml' + responses: + '200': + description: Request succeeded. + content: + application/json: + schema: + $ref: '../schemas/PublicIdentityConfig.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/public-identities.yaml b/static/api-specs/idn/v2025/paths/public-identities.yaml new file mode 100644 index 000000000..8c7d5e856 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/public-identities.yaml @@ -0,0 +1,118 @@ +get: + operationId: getPublicIdentities + tags: + - Public Identities + summary: Get list of public identities + description: Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts. + security: + - userAuth: [sp:scopes:default] + x-sailpoint-userLevels: + - USER + parameters: + - $ref: '../parameters/limit.yaml' + - $ref: '../parameters/offset.yaml' + - $ref: '../parameters/count.yaml' + - in: query + name: filters + schema: + type: string + required: false + description: >- + Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) + + + Filtering is supported for the following fields and operators: + + + **id**: *eq, in* + + + **alias**: *eq, sw* + + + **email**: *eq, sw* + + + **firstname**: *eq, sw* + + + **lastname**: *eq, sw* + example: firstname eq "John" + - in: query + name: add-core-filters + description: >- + If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: + - Should be either correlated or protected. + - Should not be "spadmin" or "cloudadmin". + - uid should not be null. + - lastname should not be null. + - email should not be null. + required: false + example: false + schema: + type: boolean + default: false + - in: query + name: sorters + schema: + type: string + format: comma-separated + required: false + description: >- + Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **name** + example: name + responses: + '200': + description: A list of public identity objects. + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/PublicIdentity.yaml' + example: + - id: 2c9180857182305e0171993735622948 + name: Alison Ferguso + alias: alison.ferguso + email: alison.ferguso@acme-solar.com + status: Active + manager: + type: IDENTITY + id: 2c9180a46faadee4016fb4e018c20639 + name: Thomas Edison + attributes: + - key: phone + name: Phone + value: '5125551234' + - key: country + name: Country + value: US + - id: 2c9180a46faadee4016fb4e018c20639 + name: Thomas Edison + alias: thomas.edison + email: thomas.edison@acme-solar.com + status: Active + manager: + type: IDENTITY + id: 2c918086676d3e0601677611dbde220f + name: Mister Manager + attributes: + - key: phone + name: Phone + value: '5125554321' + - key: country + name: Country + value: US + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/query-password-info.yaml b/static/api-specs/idn/v2025/paths/query-password-info.yaml new file mode 100644 index 000000000..9f91e40b7 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/query-password-info.yaml @@ -0,0 +1,32 @@ +post: + operationId: queryPasswordInfo + tags: + - Password Management + summary: Query Password Info + security: + - applicationAuth: [] + description: | + This API is used to query password related information. + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/PasswordInfoQueryDTO.yaml' + responses: + '200': + description: Reference to the password info. + content: + application/json: + schema: + $ref: '../schemas/PasswordInfo.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/rats-access-request-recommendations.yaml b/static/api-specs/idn/v2025/paths/rats-access-request-recommendations.yaml new file mode 100644 index 000000000..63a2ed367 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/rats-access-request-recommendations.yaml @@ -0,0 +1,88 @@ +get: + operationId: listAccessRequestRecommendations + summary: Access Request Recommendations List + tags: + - Access Request Recommendations + description: >- + This endpoint returns a list of access request recommendations. + See "identity-id" query parameter below for authorization info. + parameters: + - in: query + name: identity-id + required: false + schema: + type: string + default: me + description: >- + The response returns access request recommendations for the identity with the specified ID. *me* indicates the current user. + * ORG_ADMIN users can call this with any identity ID value. + * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. + - in: query + name: include-translation-messages + description: >- + If *true* it will populate a list of translation messages in the response. + schema: + type: boolean + default: false + required: false + example: false + - in: query + name: limit + description: >- + Max number of results to return. + required: false + schema: + type: integer + minimum: 0 + maximum: 15 + default: 15 + - $ref: '../parameters/offset.yaml' + - $ref: '../parameters/count.yaml' + - in: query + name: filters + schema: + type: string + description: >- + 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: + + + **access.name**: *co* + + + **access.description**: *co* + + + **access.type**: *eq, in* + - in: query + name: sorters + schema: + type: string + format: comma-separated + description: >- + Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **access.name, access.type** + + + By default the recommendations are sorted by highest confidence first. + responses: + '200': + description: List of access request recommendations for the specified identity. + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/AccessRecommendation.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/reassignment-configuration-config-type.yaml b/static/api-specs/idn/v2025/paths/reassignment-configuration-config-type.yaml new file mode 100644 index 000000000..6611e43b8 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/reassignment-configuration-config-type.yaml @@ -0,0 +1,45 @@ +delete: + operationId: deleteReassignmentConfiguration + tags: + - Work Reassignment + summary: Delete Reassignment Configuration + description: >- + Deletes a single reassignment configuration for the specified identity + security: + - userAuth: + - idn:reassignment-configuration:delete + parameters: + - in: path + name: identityId + schema: + type: string + description: unique identity id + required: true + x-sailpoint-resource-operation-id: listIdentities + example: 2c91808781a71ddb0181b9090b5c504e + - in: path + name: configType + schema: + $ref: '../schemas/work-reassignment/ConfigTypeEnum.yaml' + required: true + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '204': + description: Reassignment Configuration deleted + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/reassignment-configuration-evaluate.yaml b/static/api-specs/idn/v2025/paths/reassignment-configuration-evaluate.yaml new file mode 100644 index 000000000..709762954 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/reassignment-configuration-evaluate.yaml @@ -0,0 +1,78 @@ +get: + operationId: getEvaluateReassignmentConfiguration + tags: + - Work Reassignment + summary: Evaluate Reassignment Configuration + description: Evaluates the Reassignment Configuration for an `Identity` to determine + if work items for the specified type should be reassigned. If a valid Reassignment + Configuration is found for the identity & work type, then a lookup is initiated + which recursively fetches the Reassignment Configuration for the next `TargetIdentity` + until no more results are found or a max depth of 5. That lookup trail is provided + in the response and the final reassigned identity in the lookup list is returned + as the `reassignToId` property. If no Reassignment Configuration is found for + the specified identity & config type then the requested Identity ID will be used + as the `reassignToId` value and the lookupTrail node will be empty. + security: + - userAuth: + - idn:reassignment-configuration:evaluate + parameters: + - in: path + name: identityId + required: true + x-sailpoint-resource-operation-id: listIdentities + schema: + type: string + description: unique identity id + example: 2c91808781a71ddb0181b9090b5c504e + - in: path + name: configType + required: true + schema: + $ref: ../schemas/work-reassignment/ConfigTypeEnum.yaml + description: Reassignment work type + example: accessRequests + - in: query + name: exclusionFilters + required: false + schema: + type: array + items: + type: string + description: 'Exclusion filters that disable parts of the reassignment evaluation. + Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude + delegations of self-review reassignments' + example: SELF_REVIEW_DELEGATION + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Evaluated Reassignment Configuration + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/work-reassignment/EvaluateResponse.yaml + examples: + empty: + $ref: ../schemas/work-reassignment/examples/evaluateEmpty.yaml + longTrail: + $ref: ../schemas/work-reassignment/examples/evaluateLong.yaml + selfReview: + $ref: ../schemas/work-reassignment/examples/evaluateSelfReview.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/reassignment-configuration-types.yaml b/static/api-specs/idn/v2025/paths/reassignment-configuration-types.yaml new file mode 100644 index 000000000..875edcf16 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/reassignment-configuration-types.yaml @@ -0,0 +1,38 @@ +get: + operationId: getReassignmentConfigTypes + tags: + - Work Reassignment + summary: List Reassignment Config Types + description: Gets a collection of types which are available in the Reassignment + Configuration UI. + security: + - userAuth: + - idn:reassignment-configuration:read + responses: + '200': + description: List of Reassignment Configuration Types + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/work-reassignment/ConfigType.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true diff --git a/static/api-specs/idn/v2025/paths/reassignment-configuration.yaml b/static/api-specs/idn/v2025/paths/reassignment-configuration.yaml new file mode 100644 index 000000000..6a7572151 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/reassignment-configuration.yaml @@ -0,0 +1,95 @@ +get: + operationId: getReassignmentConfiguration + tags: + - Work Reassignment + summary: Get Reassignment Configuration + description: Gets the Reassignment Configuration for an identity. + security: + - userAuth: + - idn:reassignment-configuration:read + parameters: + - in: path + name: identityId + schema: + type: string + description: unique identity id + required: true + x-sailpoint-resource-operation-id: listIdentities + example: 2c91808781a71ddb0181b9090b5c504f + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Reassignment Configuration for an identity + content: + application/json: + schema: + $ref: ../schemas/work-reassignment/ConfigurationResponse.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml +put: + operationId: putReassignmentConfig + tags: + - Work Reassignment + summary: Update Reassignment Configuration + description: Replaces existing Reassignment configuration for an identity with the + newly provided configuration. + security: + - userAuth: + - idn:reassignment-configuration:update + parameters: + - in: path + name: identityId + schema: + type: string + description: unique identity id + required: true + x-sailpoint-resource-operation-id: listIdentities + example: 2c91808781a71ddb0181b9090b5c504e + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + requestBody: + required: true + content: + application/json: + schema: + $ref: ../schemas/work-reassignment/ConfigurationItemRequest.yaml + responses: + '200': + description: Reassignment Configuration updated + content: + application/json: + schema: + $ref: ../schemas/work-reassignment/ConfigurationItemResponse.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/reassignment-configurations.yaml b/static/api-specs/idn/v2025/paths/reassignment-configurations.yaml new file mode 100644 index 000000000..d4adc1baa --- /dev/null +++ b/static/api-specs/idn/v2025/paths/reassignment-configurations.yaml @@ -0,0 +1,80 @@ +get: + operationId: listReassignmentConfigurations + tags: + - Work Reassignment + summary: List Reassignment Configurations + description: Gets all Reassignment configuration for the current org. + security: + - userAuth: + - idn:reassignment-configuration:read + responses: + '200': + description: A list of Reassignment Configurations for an org + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/work-reassignment/ConfigurationResponse.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true +post: + operationId: createReassignmentConfiguration + tags: + - Work Reassignment + summary: Create a Reassignment Configuration + description: Creates a new Reassignment Configuration for the specified identity. + security: + - userAuth: + - idn:reassignment-configuration:create + requestBody: + required: true + content: + application/json: + schema: + $ref: ../schemas/work-reassignment/ConfigurationItemRequest.yaml + responses: + '201': + description: The newly created Reassignment Configuration object + content: + application/json: + schema: + $ref: ../schemas/work-reassignment/ConfigurationItemResponse.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true diff --git a/static/api-specs/idn/v2025/paths/recommendations-config.yaml b/static/api-specs/idn/v2025/paths/recommendations-config.yaml new file mode 100644 index 000000000..b507ba456 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/recommendations-config.yaml @@ -0,0 +1,78 @@ +get: + operationId: getRecommendationsConfig + summary: Get certification recommendation config values + tags: + - IAI Recommendations + description: Retrieves configuration attributes used by certification recommendations. + responses: + '200': + description: Cert recommendation configuration attributes + content: + application/json: + schema: + $ref: ../schemas/RecommendationConfigDto.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: [ iai:configuration:read ] + x-sailpoint-userLevels: + - ORG_ADMIN + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true +put: + operationId: updateRecommendationsConfig + summary: Update certification recommendation config values + tags: + - IAI Recommendations + description: Updates configuration attributes used by certification recommendations. + requestBody: + required: true + content: + application/json: + schema: + $ref: ../schemas/RecommendationConfigDto.yaml + responses: + '200': + description: Cert recommendation configuration attributes after update + content: + application/json: + schema: + $ref: ../schemas/RecommendationConfigDto.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: [ iai:configuration:manage ] + x-sailpoint-userLevels: + - ORG_ADMIN + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true diff --git a/static/api-specs/idn/v2025/paths/recommendations-request.yaml b/static/api-specs/idn/v2025/paths/recommendations-request.yaml new file mode 100644 index 000000000..eed8de5ea --- /dev/null +++ b/static/api-specs/idn/v2025/paths/recommendations-request.yaml @@ -0,0 +1,44 @@ +post: + operationId: getRecommendations + summary: Returns Recommendation Based on Object + tags: + - IAI Recommendations + description: The getRecommendations API returns recommendations based on the requested + object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins + that retrieve recommendations based on the performed calculations. + requestBody: + required: true + content: + application/json: + schema: + $ref: ../schemas/RecommendationRequestDto.yaml + responses: + '200': + description: The recommendations for a customer + content: + application/json: + schema: + $ref: ../schemas/RecommendationResponseDto.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: [ iai:decisions:manage ] + x-sailpoint-userLevels: + - Any + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true diff --git a/static/api-specs/idn/v2025/paths/reject-access-request-approval.yaml b/static/api-specs/idn/v2025/paths/reject-access-request-approval.yaml new file mode 100644 index 000000000..931183149 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/reject-access-request-approval.yaml @@ -0,0 +1,38 @@ +post: + operationId: rejectAccessRequest + summary: Reject Access Request Approval + tags: + - Access Request Approvals + description: >- + Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. + parameters: + - in: path + name: approvalId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listPendingApprovals + description: Approval ID. + example: 2c91808b7294bea301729568c68c002e + requestBody: + description: Reviewer's comment. + required: true + content: + application/json: + schema: + $ref: "../schemas/CommentDto.yaml" + responses: + '202': + $ref: '../responses/202.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/remove-account.yaml b/static/api-specs/idn/v2025/paths/remove-account.yaml new file mode 100644 index 000000000..682e473d7 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/remove-account.yaml @@ -0,0 +1,62 @@ +post: + operationId: deleteAccountAsync + summary: Remove Account + tags: + - Accounts + description: 'Use this endpoint to remove accounts from the system without provisioning + changes to the source. Accounts that are removed could be re-created during the + next aggregation. + + + This endpoint is good for: + + * Removing accounts that no longer exist on the source. + + * Removing accounts that won''t be aggregated following updates to the source + configuration. + + * Forcing accounts to be re-created following the next aggregation to re-run account + processing, support testing, etc. + + ' + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listAccounts + description: The account id + example: c350d6aa4f104c61b062cb632421ad10 + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '202': + description: Accepted. Returns task result details of removal request. + content: + application/json: + schema: + $ref: ../schemas/TaskResultDto.yaml + example: + type: TASK_RESULT + id: 464ae7bf791e49fdb74606a2e4a89635 + name: null + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: + - idn:accounts:manage diff --git a/static/api-specs/idn/v2025/paths/remove-accounts.yaml b/static/api-specs/idn/v2025/paths/remove-accounts.yaml new file mode 100644 index 000000000..d475bbcc9 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/remove-accounts.yaml @@ -0,0 +1,62 @@ +post: + operationId: deleteAccountsAsync + summary: Remove All Accounts in a Source + tags: + - Sources + description: 'Use this endpoint to remove all accounts from the system without provisioning + changes to the source. Accounts that are removed could be re-created during the + next aggregation. + + + This endpoint is good for: + + * Removing accounts that no longer exist on the source. + + * Removing accounts that won''t be aggregated following updates to the source + configuration. + + * Forcing accounts to be re-created following the next aggregation to re-run account + processing, support testing, etc. + + ' + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSources + description: The source id + example: ebbf35756e1140699ce52b233121384a + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '202': + description: Accepted. Returns task result details of removal request. + content: + application/json: + schema: + $ref: ../schemas/TaskResultDto.yaml + example: + type: TASK_RESULT + id: 464ae7bf791e49fdb74606a2e4a89635 + name: null + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: + - idn:accounts:manage diff --git a/static/api-specs/idn/v2025/paths/reports-cancel.yaml b/static/api-specs/idn/v2025/paths/reports-cancel.yaml new file mode 100644 index 000000000..e59a2f394 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/reports-cancel.yaml @@ -0,0 +1,33 @@ +post: + tags: + - Reports Data Extraction + description: >- + Cancels a running report. + operationId: cancelReport + summary: "Cancel Report" + security: + - userAuth: [sp:report:delete] + parameters: + - name: id + in: path + description: ID of the running Report to cancel + required: true + x-sailpoint-resource-operation-id: startReport + style: simple + explode: false + schema: + type: string + example: 'a1ed223247144cc29d23c632624b4767' + responses: + '204': + $ref: '../responses/204.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/reports-get-file.yaml b/static/api-specs/idn/v2025/paths/reports-get-file.yaml new file mode 100644 index 000000000..befde2c20 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/reports-get-file.yaml @@ -0,0 +1,90 @@ +get: + tags: + - Reports Data Extraction + description: >- + Gets a report in file format. + operationId: getReport + summary: "Get Report File" + security: + - userAuth: [sp:report:read] + parameters: + - in: path + name: taskResultId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: startReport + description: Unique identifier of the task result which handled report + example: ef38f94347e94562b5bb8424a56397d8 + - in: query + name: fileFormat + schema: + type: string + enum: + - csv + - pdf + required: true + description: Output format of the requested report file + example: csv + - in: query + name: name + required: false + schema: + type: string + example: 'Identities Details Report' + description: preferred Report file name, by default will be used report name from task result. + - in: query + name: auditable + required: false + schema: + type: boolean + default: false + example: true + description: >- + Enables auditing for current report download. + Will create an audit event and sent it to the REPORT cloud-audit kafka topic. + Event will be created if there is any result present by requested taskResultId. + responses: + '200': + description: Report file in selected format. CSV by default. + content: + application/csv: + schema: + type: string + format: binary + application/pdf: + schema: + type: string + format: binary + headers: + Content-disposition: + description: The requested report's filename + schema: + type: string + example: 'attachment;filename=\"fileName"' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + content: + application/json: + schema: + $ref: '../schemas/ErrorResponseDto.yaml' + examples: + "404": + summary: An example of a 404 response object + value: + detailCode: "404 Not found" + trackingId: "b21b1f7ce4da4d639f2c62a57171b427" + messages: + - locale: "en-US" + localeOrigin: "DEFAULT" + text: "
File Not Found - 404 Error
The requested file was not found." + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/reports-result.yaml b/static/api-specs/idn/v2025/paths/reports-result.yaml new file mode 100644 index 000000000..9a92a70b6 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/reports-result.yaml @@ -0,0 +1,47 @@ +get: + tags: + - Reports Data Extraction + description: >- + Get the report results for a report that was run or is running. + Returns empty report result in case there are no active task definitions with used in payload task definition name. + operationId: getReportResult + summary: "Get Report Result" + security: + - userAuth: [sp:report-result:read] + parameters: + - in: path + name: taskResultId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: startReport + description: Unique identifier of the task result which handled report + example: ef38f94347e94562b5bb8424a56397d8 + - in: query + name: completed + schema: + type: boolean + default: false + required: false + description: state of task result to apply ordering when results are fetching from the DB + example: true + responses: + '200': + description: Details about report that was run or is running. + content: + application/json: + schema: + $ref: '../schemas/reports/ReportResults.yaml' + examples: + identityDetailsReport: + $ref: '../schemas/reports/examples/identities-details-report-results.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/reports-run.yaml b/static/api-specs/idn/v2025/paths/reports-run.yaml new file mode 100644 index 000000000..1489e4d5d --- /dev/null +++ b/static/api-specs/idn/v2025/paths/reports-run.yaml @@ -0,0 +1,63 @@ +post: + tags: + - Reports Data Extraction + description: >- + Use this API to run a report according to report input details. + If non-concurrent task is already running then it returns, otherwise new task creates and returns. + operationId: startReport + summary: "Run Report" + security: + - userAuth: [sp:report:manage] + - applicationAuth: [sp:report:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + - CERT_ADMIN + - REPORT_ADMIN + - ROLE_ADMIN + - ROLE_SUBADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN + requestBody: + content: + application/json: + schema: + $ref: '../schemas/reports/ReportDetails.yaml' + examples: + Account Export Report: + $ref: '../schemas/reports/examples/account-export-report-details.yaml' + Identities Details Report: + $ref: '../schemas/reports/examples/identities-details-report-details.yaml' + Identities Report: + $ref: '../schemas/reports/examples/identities-report-details.yaml' + Identity Profile Identity Error Report: + $ref: '../schemas/reports/examples/identity-profile-identity-error-report-details.yaml' + Orphan Identities Report: + $ref: '../schemas/reports/examples/orphan-identities-report-details.yaml' + Search Export Report: + $ref: '../schemas/reports/examples/search-export-report-details.yaml' + Uncorrelated Accounts Report: + $ref: '../schemas/reports/examples/uncorrelated-accounts-report-details.yaml' + + required: true + responses: + '200': + description: Details about running report task. + content: + application/json: + schema: + $ref: '../schemas/reports/TaskResultDetails.yaml' + examples: + identityDetailsReport: + $ref: '../schemas/reports/examples/identities-details-report-task-result.yaml' + searchExportReport: + $ref: '../schemas/reports/examples/search-export-report-task-result.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/requestable-object-list.yaml b/static/api-specs/idn/v2025/paths/requestable-object-list.yaml new file mode 100644 index 000000000..079314c7d --- /dev/null +++ b/static/api-specs/idn/v2025/paths/requestable-object-list.yaml @@ -0,0 +1,107 @@ +get: + operationId: listRequestableObjects + tags: + - Requestable Objects + summary: Requestable Objects List + security: + - userAuth: [idn:requestable-objects:read] + x-sailpoint-userLevels: + - ORG_ADMIN + description: >- + Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v2024/access-requests). + Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. + + Any authenticated token can call this endpoint to see their requestable access items. + parameters: + - in: query + name: identity-id + required: false + schema: + type: string + example: e7eab60924f64aa284175b9fa3309599 + description: >- + If present, the value returns only requestable objects for the specified identity. + * Admin users can call this with any identity ID value. + * Non-admin users can only specify *me* or pass their own identity ID value. + * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. + - in: query + name: types + description: >- + Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, + all types are returned. SailPoint may add support for additional types in the future without notice. + required: false + schema: + type: array + items: + $ref: '../schemas/RequestableObjectType.yaml' + example: ROLE,ACCESS_PROFILE + explode: false + - in: query + name: term + required: false + schema: + type: string + example: "Finance Role" + description: >- + Allows searching requestable access items with a partial match on the name or description. + If `term` is provided, then the API will ignore the `filter` query parameter. + - in: query + name: statuses + description: >- + Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. + Specifying this parameter without also specifying an `identity-id` parameter results in an error. + SailPoint may add additional statuses in the future without notice. + required: false + schema: + type: array + items: + $ref: '../schemas/RequestableObjectRequestStatus.yaml' + explode: false + example: ["ASSIGNED","PENDING"] + - $ref: '../parameters/limit.yaml' + - $ref: '../parameters/offset.yaml' + - $ref: '../parameters/count.yaml' + - in: query + name: filters + schema: + type: string + example: 'name sw "bob"' + description: | + Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) + + Filtering is supported for the following fields and operators: + + **id**: *eq, in* + + **name**: *eq, in, sw* + required: false + - in: query + name: sorters + schema: + type: string + format: comma-separated + required: false + example: name + description: | + Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + Sorting is supported for the following fields: **name** + responses: + '200': + description: List of requestable objects + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/RequestableObject.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/reset-entitlements.yaml b/static/api-specs/idn/v2025/paths/reset-entitlements.yaml new file mode 100644 index 000000000..8c9227a7f --- /dev/null +++ b/static/api-specs/idn/v2025/paths/reset-entitlements.yaml @@ -0,0 +1,47 @@ +post: + operationId: resetSourceEntitlements + tags: + - Entitlements + summary: Reset Source Entitlements + description: >- + Remove all entitlements from a specific source. + + To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. + To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/v2024/import-accounts/) with `disableOptimization` = `true`. + parameters: + - name: id + in: path + description: ID of source for the entitlement reset + required: true + x-sailpoint-resource-operation-id: listSources + schema: + type: string + example: 2c91808a7813090a017814121919ecca + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '202': + description: Entitlement source reset task result + content: + application/json: + schema: + $ref: ../schemas/EntitlementSourceResetBaseReferenceDto.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: + - idn:entitlement:update diff --git a/static/api-specs/idn/v2025/paths/role-access-model-metadata/role-bulk-update-filter.yaml b/static/api-specs/idn/v2025/paths/role-access-model-metadata/role-bulk-update-filter.yaml new file mode 100644 index 000000000..22c7c55b8 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-access-model-metadata/role-bulk-update-filter.yaml @@ -0,0 +1,56 @@ +post: + operationId: updateRolesMetadataByFilter + summary: Bulk-Update Roles' Metadata by Filters + description: >- + This API initiates a bulk update of metadata for one or more Roles + by filter. + + A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. + + The maximum metadata value count for a single role is 25. + + Custom metadata update, including add, replace need suit licensed. + tags: + - Roles + security: + - UserContextAuth: + - idn:role:update + - idn:role-checked:update + requestBody: + required: true + content: + application/json: + schema: + $ref: "../../schemas/role-metadata/RoleMetadataBulkUpdateByFilterRequest.yaml" + example: + operation: ADD + replaceScope: ALL + filters: requestable eq false + values: + - attribute: iscFederalClassifications + values: + - topSecret + responses: + "202": + description: Returned if bulk update request created + content: + application/json: + schema: + $ref: "../../schemas/role-metadata/RoleBulkUpdateResponse.yaml" + examples: + Update request created successfully: + value: + id: 2d82ac17-eb0d-4ba6-9918-dcad6ee0294d + type: ROLE + status: CREATED + created: 2024-09-16T18:59:06.871594Z + "400": + $ref: ../../responses/400.yaml + "401": + $ref: ../../responses/401.yaml + "403": + $ref: ../../responses/403.yaml + "429": + $ref: ../../responses/429.yaml + "500": + $ref: ../../responses/500.yaml \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/role-access-model-metadata/role-bulk-update-ids.yaml b/static/api-specs/idn/v2025/paths/role-access-model-metadata/role-bulk-update-ids.yaml new file mode 100644 index 000000000..f9817120a --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-access-model-metadata/role-bulk-update-ids.yaml @@ -0,0 +1,41 @@ +post: + operationId: updateRolesMetadataByIds + summary: Bulk-Update Roles' Metadata by ID + description: >- + This API initiates a bulk update of metadata for one or more Roles by a list of Role Ids. + + A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. + + The maximum role count in a single update request is 3000. + The maximum metadata value count for a single role is 25. + + Custom metadata update, including add, replace need suit licensed. + tags: + - Roles + security: + - UserContextAuth: + - idn:role:update + - idn:role-checked:update + requestBody: + required: true + content: + application/json: + schema: + $ref: "../../schemas/role-metadata/RoleMetadataBulkUpdateByIdRequest.yaml" + responses: + "202": + description: Returned if bulk update request created + content: + application/json: + schema: + $ref: "../../schemas/role-metadata/RoleBulkUpdateResponse.yaml" + '400': + $ref: '../../responses/400.yaml' + '401': + $ref: '../../responses/401.yaml' + '403': + $ref: '../../responses/403.yaml' + '429': + $ref: '../../responses/429.yaml' + '500': + $ref: '../../responses/500.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/role-access-model-metadata/role-bulk-update-query.yaml b/static/api-specs/idn/v2025/paths/role-access-model-metadata/role-bulk-update-query.yaml new file mode 100644 index 000000000..d041556d6 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-access-model-metadata/role-bulk-update-query.yaml @@ -0,0 +1,79 @@ +post: + operationId: updateRolesMetadataByQuery + summary: Bulk-Update Roles' Metadata by Query + description: >- + This API initiates a bulk update of metadata for one or more Roles by query. + + A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. + + The maximum metadata value count for a single role is 25. + + Custom metadata update, including add, replace need suit licensed. + tags: + - Roles + security: + - UserContextAuth: [ idn:role:update, idn:role-checked:update ] + requestBody: + required: true + content: + application/json: + schema: + $ref: '../../schemas/role-metadata/RoleMetadataBulkUpdateByQueryRequest.yaml' + example: + example of a success update: + { + "query": { + "indices": [ + "roles" + ], + "queryType": "TEXT", + "textQuery": { + "terms": [ + "test123" + ], + "fields": [ + "id" + ], + "matchAny": false, + "contains": true + }, + "includeNested": false + }, + "operation": "REPLACE", + "replaceScope": "ALL", + "values": [ + { + "attribute": "iscFederalClassifications", + "values": [ + "secret" + ] + } + ] + } + responses: + '202': + description: Returned if bulk update request created + content: + application/json: + schema: + $ref: '../../schemas/role-metadata/RoleBulkUpdateResponse.yaml' + examples: + Update request created successfully: + value: + { + "id": "2d82ac17-eb0d-4ba6-9918-dcad6ee0294d", + "type": "ROLE", + "status": "CREATED", + "created": "2024-09-16T18:59:06.871594Z" + } + + '400': + $ref: '../../responses/400.yaml' + '401': + $ref: '../../responses/401.yaml' + '403': + $ref: '../../responses/403.yaml' + '429': + $ref: '../../responses/429.yaml' + '500': + $ref: '../../responses/500.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/role-access-model-metadata/role-bulk-update-status-id.yaml b/static/api-specs/idn/v2025/paths/role-access-model-metadata/role-bulk-update-status-id.yaml new file mode 100644 index 000000000..1a3424b3c --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-access-model-metadata/role-bulk-update-status-id.yaml @@ -0,0 +1,50 @@ +get: + operationId: getBulkUpdateStatusById + summary: Get Bulk-Update Status by ID + description: >- + + This API initial a request for one bulk update's status by bulk update Id + returns the status of the bulk update process. + + A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. + + security: + - UserContextAuth: [ idn:role:update, idn:role-checked:update ] + tags: + - Roles + parameters: + - name: "id" + in: path + required: true + schema: + type: string + description: The Id of the bulk update task. + example: c24359c389374d0fb8585698a2189e3d + + responses: + '202': + description: return if bulk update status could be found. + content: + application/json: + schema: + $ref: '../../../v2024/schemas/role-metadata/RoleBulkUpdateResponse.yaml' + examples: + Update request created successfully: + value: + { + "id": "2d82ac17-eb0d-4ba6-9918-dcad6ee0294d", + "type": "ROLE", + "status": "CREATED", + "created": "2024-09-16T18:59:06.871594Z" + } + + '400': + $ref: '../../responses/400.yaml' + '401': + $ref: '../../responses/401.yaml' + '403': + $ref: '../../responses/403.yaml' + '429': + $ref: '../../responses/429.yaml' + '500': + $ref: '../../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/role-access-model-metadata/role-bulk-update-status.yaml b/static/api-specs/idn/v2025/paths/role-access-model-metadata/role-bulk-update-status.yaml new file mode 100644 index 000000000..eecf7cfe4 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-access-model-metadata/role-bulk-update-status.yaml @@ -0,0 +1,34 @@ +get: + operationId: getBulkUpdateStatus + summary: Get Bulk-Update Statuses + description: >- + This API returns a list of all unfinished bulk update process status of the tenant. + + x-sailpoint-userLevels: + - ORG_ADMIN + - ROLE_ADMIN + - ROLE_SUBADMIN + security: + - userAuth: [ idn:role:update, idn:role-checked:update ] + tags: + - Roles + responses: + '200': + description: successfully get the status of all unfinished bulk updates request. + content: + application/json: + schema: + type: array + items: + $ref: '../../schemas/role-metadata/RoleGetAllBulkUpdateResponse.yaml' + + '400': + $ref: '../../responses/400.yaml' + '401': + $ref: '../../responses/401.yaml' + '403': + $ref: '../../responses/403.yaml' + '429': + $ref: '../../responses/429.yaml' + '500': + $ref: '../../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/role-access-model-metadata/role-filter.yaml b/static/api-specs/idn/v2025/paths/role-access-model-metadata/role-filter.yaml new file mode 100644 index 000000000..af46e0dd9 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-access-model-metadata/role-filter.yaml @@ -0,0 +1,143 @@ +post: + operationId: searchRolesByFilter + summary: Filter Roles by Metadata + description: >- + This API returns a list of Role that filter by metadata and filter, it support filter by both path parameter and + attribute key and values. + + A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, HELPDESK, CERT_ADMIN, REPORT_ADMIN or SOURCE_ADMIN authority is required to call this API. + + security: + - UserContextAuth: [ idn:role:read, idn:role-checked:read ] + tags: + - Roles + parameters: + - name: for-subadmin + in: query + schema: + type: string + description: >- + If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. + The value of the parameter is either an Identity ID, or the special value **me**, + which is shorthand for the calling Identity's ID. + A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not + a subadmin. + example: 5168015d32f890ca15812c9180835d2e + required: false + - name: limit + in: query + schema: + type: integer + format: int32 + minimum: 0 + maximum: 250 + default: 50 + description: >- + Max number of results to return + See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) + for more information. + example: 50 + required: false + + - name: offset + in: query + description: >- + 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. + schema: + type: integer + format: int32 + minimum: 0 + default: 0 + required: false + example: 0 + + - name: count + in: query + description: >- + Boolean indicating whether a total count is returned, factoring in any filter parameters, in the X-Total-Count response header. + The value is the total size of the collection that would be returned if limit and offset were ignored. + + See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) + for more information. + schema: + type: boolean + default: false + required: false + example: true + + - name: sorters + in: query + schema: + type: string + description: >- + Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **name, created, modified** + example: name,-modified + required: false + + - name: for-segment-ids + in: query + schema: + type: string + description: >- + If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) + with the specified IDs. + + If segmentation is currently unavailable, specifying this parameter results in an error. + example: 0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d + required: false + + - name: include-unsegmented + in: query + description: >- + Whether or not the response list should contain unsegmented Roles. + If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. + schema: + type: boolean + default: true + required: false + example: false + - $ref: '../../parameters/count.yaml' + + requestBody: + content: + application/json: + schema: + $ref: '../../schemas/role-metadata/RoleListFilterDTO.yaml' + example: + { + "filters": "dimensional eq false", + "ammKeyValues": [ + { + "attribute": "iscFederalClassifications", + "values": [ + "secret" + ] + } + ] + } + + responses: + '200': + description: Responds with A list of Roles + content: + application/json: + schema: + type: array + allOf: + - $ref: '../../schemas/access/Role.yaml' + '400': + $ref: '../../responses/400.yaml' + '401': + $ref: '../../responses/401.yaml' + '403': + $ref: '../../responses/403.yaml' + '429': + $ref: '../../responses/429.yaml' + '500': + $ref: '../../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/role-access-model-metadata/role-id-access-model-metadata.yaml b/static/api-specs/idn/v2025/paths/role-access-model-metadata/role-id-access-model-metadata.yaml new file mode 100644 index 000000000..b9a3114d1 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-access-model-metadata/role-id-access-model-metadata.yaml @@ -0,0 +1,104 @@ +post: + operationId: updateAttributeKeyAndValueToRole + summary: Add a Metadata to Role. + description: + This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. + A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. + The maximum number of attributes in one role is 25. + Custom metadata update, including ADD and REPLACE need suit licensed. + tags: + - Roles + security: + - userAuth: [ idn:role:update, idn:role-checked:update ] + x-sailpoint-userLevels: + - ORG_ADMIN + - ROLE_ADMIN + - ROLE_SUBADMIN + parameters: + - name: "id" + in: "path" + required: true + schema: + type: "string" + description: The Id of a role + example: c24359c389374d0fb8585698a2189e3d + - name: "attributeKey" + in: "path" + required: true + schema: + type: "string" + description: Technical name of the Attribute. + example: "iscPrivacy" + - name: "attributeValue" + in: "path" + required: true + schema: + type: "string" + description: Technical name of the Attribute Value. + example: "public" + responses: + "200": + description: Responds with the Role as updated. + content: + application/json: + schema: + $ref: "../../schemas/access/Role.yaml" + '400': + $ref: '../../responses/400.yaml' + '401': + $ref: '../../responses/401.yaml' + '403': + $ref: '../../responses/403.yaml' + '429': + $ref: '../../responses/429.yaml' + '500': + $ref: '../../responses/500.yaml' +delete: + operationId: deleteMetadataFromRoleByKeyAndValue + summary: Remove a Metadata From Role. + description: + This API initialize a request to remove a single Access Model Metadata from a role by attribute key and value. + A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. + tags: + - Roles + security: + - userAuth: [ idn:role:delete, idn:role-checked:delete, idn:role:update, idn:role-checked:update ] + x-sailpoint-userLevels: + - ORG_ADMIN + - ROLE_ADMIN + - ROLE_SUBADMIN + parameters: + - name: id + in: path + required: true + schema: + type: string + description: The role's id. + example: 2c91808c74ff913f0175097daa9d59cd + - name: attributeKey + in: path + required: true + schema: + type: string + description: Technical name of the Attribute. + example: "iscPrivacy" + - name: attributeValue + in: "path" + required: true + schema: + type: string + description: Technical name of the Attribute Value. + example: "public" + responses: + "202": + description: Request accepted + '400': + $ref: '../../responses/400.yaml' + '401': + $ref: '../../responses/401.yaml' + '403': + $ref: '../../responses/403.yaml' + '429': + $ref: '../../responses/429.yaml' + '500': + $ref: '../../responses/500.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/role-access-profiles.yaml b/static/api-specs/idn/v2025/paths/role-access-profiles.yaml new file mode 100644 index 000000000..a3e28f224 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-access-profiles.yaml @@ -0,0 +1,87 @@ +get: + operationId: listRoleAccessProfiles + tags: + - Roles + summary: List Role's Access Profiles + description: >- + This API lists the Access Profiles associated with a given Role + + + A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a + token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated + to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + parameters: + - name: id + in: path + description: ID of the Role + required: true + schema: + type: string + example: 2c91808a7813090a017814121919ecca + - $ref: '../parameters/limit.yaml' + - $ref: '../parameters/offset.yaml' + - $ref: '../parameters/count.yaml' + - in: query + name: filters + schema: + type: string + description: >- + Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) + + + Filtering is supported for the following fields and operators: + + + **id**: *eq, in* + + + **name**: *eq, sw* + + + **created**: *gt, lt, ge, le* + + + **modified**: *gt, lt, ge, le* + + + **owner.id**: *eq, in* + + + **source.id**: *eq, in* + example: source.id eq "2c91808982f979270182f99e386d00fa" + required: false + - in: query + name: sorters + schema: + type: string + format: comma-separated + description: >- + Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **name, created, modified** + example: name,-modified + required: false + responses: + '200': + description: List of Access Profiles + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/access/AccessProfile.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + security: + - userAuth: [idn:role-unchecked:read, idn:role-unchecked:manage, idn:role-checked:manage, idn:role-checked:read] diff --git a/static/api-specs/idn/v2025/paths/role-assigned-identities.yaml b/static/api-specs/idn/v2025/paths/role-assigned-identities.yaml new file mode 100644 index 000000000..4f736dc19 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-assigned-identities.yaml @@ -0,0 +1,73 @@ +get: + operationId: getRoleAssignedIdentities + tags: + - Roles + summary: List Identities assigned a Role + parameters: + - in: path + name: id + schema: + type: string + description: >- + ID of the Role for which the assigned Identities are to be listed + example: 2c91808a7813090a017814121e121518 + required: true + x-sailpoint-resource-operation-id: listRoles + - $ref: '../parameters/limit.yaml' + - $ref: '../parameters/offset.yaml' + - $ref: '../parameters/count.yaml' + - in: query + name: filters + schema: + type: string + description: >- + Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) + + + Filtering is supported for the following fields and operators: + + + **id**: *eq, in* + + + **aliasName**: *eq, sw* + + + **email**: *eq, sw* + + + **name**: *eq, sw, co* + example: name sw Joe + - in: query + name: sorters + schema: + type: string + format: comma-separated + description: >- + Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **id, name, aliasName, email** + example: aliasName,name + responses: + '200': + description: List of Identities assigned the Role + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/access/RoleIdentity.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + security: + - userAuth: [idn:role-unchecked:read, idn:role-unchecked:manage, idn:role-checked:manage, idn:role-checked:read] + diff --git a/static/api-specs/idn/v2025/paths/role-bulk-delete.yaml b/static/api-specs/idn/v2025/paths/role-bulk-delete.yaml new file mode 100644 index 000000000..a8a85c5b7 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-bulk-delete.yaml @@ -0,0 +1,86 @@ +post: + operationId: deleteBulkRoles + summary: Delete Role(s) + tags: + - Roles + description: >- + This endpoint initiates a bulk deletion of one or more roles. + + When the request is successful, the endpoint returns the bulk delete's task result ID. + To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. + + This endpoint can only bulk delete up to a limit of 50 roles per request. + + A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated + with sources with management workgroups the ROLE_SUBADMIN is a member of. + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/access/RoleBulkDeleteRequest.yaml' + example: + { + "roleIds": [ "2c91808876438bb2017668b91919ecca","2c91808876438ba801766e129f151816" ] + } + responses: + '202': + description: Returns an object with the id of the task performing the delete operation. + content: + application/json: + schema: + $ref: '../schemas/TaskResultDto.yaml' + example: + { + "type": "TASK_RESULT", + "id": "464ae7bf791e49fdb74606a2e4a89635", + "name": null + } + '400': + description: Client Error - Returned if the request body is invalid. + content: + application/json: + schema: + $ref: '../schemas/ErrorResponseDto.yaml' + examples: + 400.1 Bad Request Content: + description: Response for bad request content + value: + detailCode: 400.1 Bad Request Content + trackingId: 1ea1adcb84da4dcb890145e05745774e + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The request was syntactically correct but its content is semantically invalid. + 400.1 Role ids limit violation: + description: Role ids limit violation response + value: + detailCode: 400.1 Bad Request Content + trackingId: 77aa89ac6f0e422dbc588866abc22be9 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: roleIds count exceeded max limit of 50 for bulk-delete. + 400.1.404 Referenced object not found: + description: Referenced object not found response + value: + detailCode: 400.1.404 Referenced object not found + trackingId: 77aa89ac6f0e422dbc588866abc22be9 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: Referenced roleIds ["2c91808876438bb2017668b91919ecca"] was not found. + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + security: + - userAuth: [idn:role-unchecked:manage, idn:role-checked:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + - ROLE_ADMIN + - ROLE_SUBADMIN diff --git a/static/api-specs/idn/v2025/paths/role-entitlements.yaml b/static/api-specs/idn/v2025/paths/role-entitlements.yaml new file mode 100644 index 000000000..5bac7f051 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-entitlements.yaml @@ -0,0 +1,109 @@ +get: + operationId: getRoleEntitlements + tags: + - Roles + summary: List Role's Entitlements + description: >- + Get a list of entitlements associated with a specified role. + parameters: + - name: id + in: path + description: Containing role's ID. + required: true + x-sailpoint-resource-operation-id: listRoles + schema: + type: string + example: 2c91808a7813090a017814121919ecca + - $ref: ../parameters/limit50.yaml + - $ref: ../parameters/offset.yaml + - $ref: ../parameters/count.yaml + - in: query + name: filters + schema: + type: string + description: 'Filter results using the standard syntax described in [V3 API Standard + Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) + + + Filtering is supported for the following fields and operators: + + + **id**: *eq, in* + + + **name**: *eq, sw* + + + **attribute**: *eq, sw* + + + **value**: *eq, sw* + + + **created**: *gt, lt, ge, le* + + + **modified**: *gt, lt, ge, le* + + + **owner.id**: *eq, in* + + + **source.id**: *eq, in*' + example: attribute eq "memberOf" + required: false + - in: query + name: sorters + schema: + type: string + format: comma-separated + description: 'Sort results using the standard syntax described in [V3 API Standard + Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **name, attribute, value, created, + modified**' + example: name,-modified + required: false + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: List of Entitlements + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/Entitlement.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: + - idn:role-unchecked:read + - idn:role-unchecked:manage + - idn:role-checked:manage + - idn:role-checked:read + - applicationAuth: + - idn:role-unchecked:read + - idn:role-unchecked:manage + - idn:role-checked:manage + - idn:role-checked:read + x-sailpoint-userLevels: + - ORG_ADMIN + - ROLE_ADMIN + - ROLE_SUBADMIN diff --git a/static/api-specs/idn/v2025/paths/role-insight.yaml b/static/api-specs/idn/v2025/paths/role-insight.yaml new file mode 100644 index 000000000..4f70c084b --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-insight.yaml @@ -0,0 +1,38 @@ +get: + operationId: getRoleInsight + summary: Get a single role insight + tags: + - Role Insights + description: This endpoint gets role insights information for a role. + parameters: + - in: path + name: insightId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getRoleInsights + description: The role insight id + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Succeeded. Returns information about insights for a single role. + content: + application/json: + schema: + $ref: ../schemas/RoleInsight.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/role-insights-current-entitlements.yaml b/static/api-specs/idn/v2025/paths/role-insights-current-entitlements.yaml new file mode 100644 index 000000000..19cf68c49 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-insights-current-entitlements.yaml @@ -0,0 +1,61 @@ +get: + operationId: getRoleInsightsCurrentEntitlements + summary: Get current entitlement for a role + tags: + - Role Insights + description: This endpoint gets the entitlements for a role. The term "current" + is to distinguish from the entitlement(s) an insight might recommend adding. + parameters: + - in: path + name: insightId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getRoleInsights + description: The role insight id + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - in: query + name: filters + description: '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: + + + **name**: *sw* + + + **description**: *sw*' + example: name sw "r" + required: false + style: form + explode: true + schema: + type: string + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Succeeded. Returns a list of current or pre-existing entitlements + for a role. + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/RoleInsightsEntitlement.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/role-insights-entitlement-changes-download.yaml b/static/api-specs/idn/v2025/paths/role-insights-entitlement-changes-download.yaml new file mode 100644 index 000000000..45a0e04ed --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-insights-entitlement-changes-download.yaml @@ -0,0 +1,74 @@ +get: + operationId: downloadRoleInsightsEntitlementsChanges + summary: Download entitlement insights for a role + tags: + - Role Insights + description: This endpoint returns the entitlement insights for a role. + parameters: + - in: path + name: insightId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getRoleInsights + description: The role insight id + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - in: query + name: sorters + description: 'Sort results using the standard syntax described in [V3 API Standard + Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **identitiesWithAccess** + + + The default sort is **identitiesWithAccess** in descending order.' + required: false + example: identitiesWithAccess + style: form + explode: true + schema: + type: string + - in: query + name: filters + description: '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: + + + **name**: *sw* + + + **description**: *sw*' + example: name sw "r" + required: false + style: form + explode: true + schema: + type: string + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Succeeded. Returns a csv file containing a list of entitlements + to be added for a role. + content: + text/csv: + schema: + type: string + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/role-insights-entitlement-changes-identities.yaml b/static/api-specs/idn/v2025/paths/role-insights-entitlement-changes-identities.yaml new file mode 100644 index 000000000..2287f5d8d --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-insights-entitlement-changes-identities.yaml @@ -0,0 +1,92 @@ +get: + operationId: getEntitlementChangesIdentities + summary: Get identities for a suggested entitlement (for a role) + tags: + - Role Insights + description: Role insights suggests entitlements to be added for a role. This endpoint + returns a list of identities in the role, with or without the entitlements, for + a suggested entitlement so that the user can see which identities would be affected + if the suggested entitlement were to be added to the role. + parameters: + - in: path + name: insightId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getRoleInsights + description: The role insight id + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - in: path + name: entitlementId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listEntitlements + description: The entitlement id + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - in: query + name: hasEntitlement + description: Identity has this entitlement or not + required: false + style: form + explode: true + schema: + type: boolean + default: false + - $ref: ../parameters/offset.yaml + - $ref: ../parameters/limit.yaml + - $ref: ../parameters/count.yaml + - in: query + name: sorters + description: 'Sort results using the standard syntax described in [V3 API Standard + Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **name**' + example: name + required: false + style: form + explode: true + schema: + type: string + - in: query + name: filters + description: '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: + + + **name**: *sw*' + example: name sw "Jan" + required: false + style: form + explode: true + schema: + type: string + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Succeeded. Returns a list of identities with or without the entitlement. + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/RoleInsightsIdentities.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/role-insights-entitlement-changes.yaml b/static/api-specs/idn/v2025/paths/role-insights-entitlement-changes.yaml new file mode 100644 index 000000000..68f0abbdf --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-insights-entitlement-changes.yaml @@ -0,0 +1,71 @@ +get: + operationId: getRoleInsightsEntitlementsChanges + summary: Get entitlement insights for a role + tags: + - Role Insights + description: This endpoint returns entitlement insights for a role. + parameters: + - in: path + name: insightId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getRoleInsights + description: The role insight id + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - in: query + name: sorters + description: 'Sort results using the standard syntax described in [V3 API Standard + Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **identitiesWithAccess, name**' + required: false + style: form + explode: true + schema: + type: string + - in: query + name: filters + description: '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: + + + **name**: *sw* + + + **description**: *sw*' + required: false + style: form + example: name sw "Admin" + explode: true + schema: + type: string + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Succeeded. Returns a list of entitlements to be added for a role. + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/RoleInsightsEntitlementChanges.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/role-insights-request.yaml b/static/api-specs/idn/v2025/paths/role-insights-request.yaml new file mode 100644 index 000000000..0eb03a188 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-insights-request.yaml @@ -0,0 +1,41 @@ +get: + operationId: getRoleInsightsRequests + summary: Returns metadata from prior request. + deprecated: true + tags: + - Role Insights + description: 'This endpoint returns details of a prior role insights request. ' + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getRoleInsights + description: The role insights request id + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Succeeded. Returns details of an earlier role insights request. + content: + application/json: + schema: + $ref: ../schemas/RoleInsightsResponse.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/role-insights-requests.yaml b/static/api-specs/idn/v2025/paths/role-insights-requests.yaml new file mode 100644 index 000000000..2364a9746 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-insights-requests.yaml @@ -0,0 +1,35 @@ +post: + operationId: createRoleInsightRequests + summary: Generate insights for roles + deprecated: true + tags: + - Role Insights + description: Submits a create role insights request to the role insights application. + At this time there are no parameters. All business roles will be processed for + the customer. + responses: + '201': + description: Submitted a role insights generation request + content: + application/json: + schema: + $ref: ../schemas/RoleInsightsResponse.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true diff --git a/static/api-specs/idn/v2025/paths/role-insights-summary.yaml b/static/api-specs/idn/v2025/paths/role-insights-summary.yaml new file mode 100644 index 000000000..505aa5d2c --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-insights-summary.yaml @@ -0,0 +1,31 @@ +get: + operationId: getRoleInsightsSummary + summary: Get role insights summary information + tags: + - Role Insights + description: This method returns high level summary information for role insights + for a customer. + responses: + '200': + description: Succeeded. Returns high level counts. + content: + application/json: + schema: + $ref: ../schemas/RoleInsightsSummary.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '500': + $ref: ../responses/500.yaml + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true diff --git a/static/api-specs/idn/v2025/paths/role-insights.yaml b/static/api-specs/idn/v2025/paths/role-insights.yaml new file mode 100644 index 000000000..3e6b2b950 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-insights.yaml @@ -0,0 +1,72 @@ +get: + operationId: getRoleInsights + summary: Get role insights + tags: + - Role Insights + description: This method returns detailed role insights for each role. + parameters: + - $ref: ../parameters/offset.yaml + - $ref: ../parameters/limit.yaml + - $ref: ../parameters/count.yaml + - name: sorters + in: query + description: 'Sort results using the standard syntax described in [V3 API Standard + Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **numberOfUpdates, identitiesWithAccess, + totalNumberOfIdentities**' + example: numberOfUpdates + required: false + style: form + explode: true + schema: + type: string + - name: filters + in: query + description: '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: + + + **name**: *sw* + + + **ownerName**: *sw* + + + **description**: *sw*' + required: false + style: form + explode: true + example: name sw "John" + schema: + type: string + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Succeeded. Returns a list of roles with information about insights + for each role. + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/RoleInsight.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/role-mining-potential-role-edit-entitlements.yaml b/static/api-specs/idn/v2025/paths/role-mining-potential-role-edit-entitlements.yaml new file mode 100644 index 000000000..9a90c4e47 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-mining-potential-role-edit-entitlements.yaml @@ -0,0 +1,55 @@ +post: + operationId: updateEntitlementsPotentialRole + summary: Edit entitlements for a potential role to exclude some entitlements + tags: + - IAI Role Mining + description: This endpoint adds or removes entitlements from an exclusion list for + a potential role. + parameters: + - in: path + name: sessionId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getRoleMiningSessions + description: The role mining session id + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - in: path + name: potentialRoleId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getPotentialRoleSummaries + description: A potential role id in a role mining session + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + requestBody: + description: Role mining session parameters + required: true + content: + application/json: + schema: + $ref: ../schemas/RoleMiningPotentialRoleEditEntitlements.yaml + responses: + '201': + description: Adds or removes entitlements from a potential role's entitlement + exclusion list. + content: + application/json: + schema: + $ref: ../schemas/RoleMiningPotentialRole.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/role-mining-potential-role-entitlement-popularities.yaml b/static/api-specs/idn/v2025/paths/role-mining-potential-role-entitlement-popularities.yaml new file mode 100644 index 000000000..276641b45 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-mining-potential-role-entitlement-popularities.yaml @@ -0,0 +1,103 @@ +get: + operationId: getEntitlementsPotentialRole + summary: Retrieves entitlements for a potential role in a role mining session + tags: + - IAI Role Mining + description: This method returns entitlements for a potential role in a role mining + session. + parameters: + - in: path + name: sessionId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getRoleMiningSessions + description: The role mining session id + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - in: path + name: potentialRoleId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getPotentialRoleSummaries + description: A potential role id in a role mining session + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - in: query + name: includeCommonAccess + description: Boolean determining whether common access entitlements will be included + or not + example: true + required: false + style: form + explode: true + schema: + type: boolean + default: true + - in: query + name: sorters + description: 'Sort results using the standard syntax described in [V3 API Standard + Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **popularity, entitlementName, + applicationName** + + + The default sort is **popularity** in descending order. ' + example: popularity + required: false + style: form + explode: true + schema: + type: string + - in: query + name: filters + description: '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: + + + **applicationName**: *sw* + + + **entitlementRef.name**: *sw*' + example: applicationName sw "AD" + required: false + style: form + explode: true + schema: + type: string + - $ref: ../parameters/offset.yaml + - $ref: ../parameters/limit.yaml + - $ref: ../parameters/count.yaml + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Succeeded. Returns a list of entitlements for a potential role. + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/RoleMiningEntitlement.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: [] diff --git a/static/api-specs/idn/v2025/paths/role-mining-potential-role-entitlement-popularity-distribution.yaml b/static/api-specs/idn/v2025/paths/role-mining-potential-role-entitlement-popularity-distribution.yaml new file mode 100644 index 000000000..4f6dea097 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-mining-potential-role-entitlement-popularity-distribution.yaml @@ -0,0 +1,60 @@ +get: + operationId: getEntitlementDistributionPotentialRole + summary: Retrieves entitlement popularity distribution for a potential role in a + role mining session + tags: + - IAI Role Mining + description: This method returns entitlement popularity distribution for a potential + role in a role mining session. + parameters: + - in: path + name: sessionId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getRoleMiningSessions + description: The role mining session id + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - in: path + name: potentialRoleId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getPotentialRoleSummaries + description: A potential role id in a role mining session + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - in: query + name: includeCommonAccess + description: Boolean determining whether common access entitlements will be included + or not + required: false + style: form + explode: true + schema: + type: boolean + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Succeeded. Returns a map containing entitlement popularity distribution + for a potential role. + content: + application/json: + schema: + type: object + additionalProperties: + type: integer + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/role-mining-potential-role-excluded-entitlements.yaml b/static/api-specs/idn/v2025/paths/role-mining-potential-role-excluded-entitlements.yaml new file mode 100644 index 000000000..cbc82fcbc --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-mining-potential-role-excluded-entitlements.yaml @@ -0,0 +1,85 @@ +get: + operationId: getExcludedEntitlementsPotentialRole + summary: Retrieves excluded entitlements for a potential role in a role mining session + tags: + - IAI Role Mining + description: This method returns excluded entitlements for a potential role in a + role mining session. + parameters: + - in: path + name: sessionId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getRoleMiningSessions + description: The role mining session id + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - in: path + name: potentialRoleId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getPotentialRoleSummaries + description: A potential role id in a role mining session + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - in: query + name: sorters + description: 'Sort results using the standard syntax described in [V3 API Standard + Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **popularity**' + example: populariity + required: false + style: form + explode: true + schema: + type: string + - in: query + name: filters + description: '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: + + + **applicationName**: *sw* + + + **entitlementRef.name**: *sw*' + example: applicationName sw "AD" + required: false + style: form + explode: true + schema: + type: string + - $ref: ../parameters/offset.yaml + - $ref: ../parameters/limit.yaml + - $ref: ../parameters/count.yaml + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Succeeded. Returns a list of excluded entitlements for a potential + roles. + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/RoleMiningEntitlement.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/role-mining-potential-role-identities.yaml b/static/api-specs/idn/v2025/paths/role-mining-potential-role-identities.yaml new file mode 100644 index 000000000..3eb5b87cd --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-mining-potential-role-identities.yaml @@ -0,0 +1,80 @@ +get: + operationId: getIdentitiesPotentialRole + summary: Retrieves identities for a potential role in a role mining session + tags: + - IAI Role Mining + description: This method returns identities for a potential role in a role mining + session. + parameters: + - in: path + name: sessionId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getRoleMiningSessions + description: The role mining session id + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - in: path + name: potentialRoleId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getPotentialRoleSummaries + description: A potential role id in a role mining session + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - in: query + name: sorters + description: 'Sort results using the standard syntax described in [V3 API Standard + Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **name**' + required: false + style: form + explode: true + example: name + schema: + type: string + - in: query + name: filters + description: '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: + + + **name**: *sw*' + required: false + style: form + explode: true + schema: + type: string + - $ref: ../parameters/offset.yaml + - $ref: ../parameters/limit.yaml + - $ref: ../parameters/count.yaml + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Succeeded. Returns a list of identities for a potential role. + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/RoleMiningIdentity.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/role-mining-potential-role-provision.yaml b/static/api-specs/idn/v2025/paths/role-mining-potential-role-provision.yaml new file mode 100644 index 000000000..9424b38f1 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-mining-potential-role-provision.yaml @@ -0,0 +1,77 @@ +post: + operationId: createPotentialRoleProvisionRequest + summary: Create request to provision a potential role into an actual role. + tags: + - IAI Role Mining + description: This method starts a job to provision a potential role + parameters: + - in: path + name: sessionId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getRoleMiningSessions + description: The role mining session id + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - in: path + name: potentialRoleId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getPotentialRoleSummaries + description: A potential role id in a role mining session + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - in: query + name: min-entitlement-popularity + description: Minimum popularity required for an entitlement to be included in + the provisioned role. + required: false + style: form + explode: true + schema: + type: integer + default: 0 + minimum: 0 + maximum: 100 + - in: query + name: include-common-access + description: Boolean determining whether common access entitlements will be included + in the provisioned role. + required: false + style: form + explode: true + schema: + type: boolean + default: true + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + requestBody: + description: Required information to create a new role + content: + application/json: + schema: + $ref: ../schemas/RoleMiningPotentialRoleProvisionRequest.yaml + responses: + '202': + description: Accepted. Returns a potential role summary including the status + of the provison request + content: + application/json: + schema: + $ref: ../schemas/RoleMiningPotentialRoleSummary.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/role-mining-potential-role-source-identity-usage.yaml b/static/api-specs/idn/v2025/paths/role-mining-potential-role-source-identity-usage.yaml new file mode 100644 index 000000000..9d2fb0487 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-mining-potential-role-source-identity-usage.yaml @@ -0,0 +1,69 @@ +get: + operationId: getPotentialRoleSourceIdentityUsage + summary: Retrieves potential role source usage + tags: + - IAI Role Mining + description: This method returns source usageCount (as number of days in the last + 90 days) for each identity in a potential role. + security: + - userAuth: [] + parameters: + - in: path + name: potentialRoleId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getPotentialRoleSummaries + description: A potential role id + example: e0cc5d7d-bf7f-4f81-b2af-8885b09d9923 + - in: path + name: sourceId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSources + description: A source id + example: 2c9180877620c1460176267f336a106f + - in: query + name: sorters + required: false + style: form + explode: true + schema: + type: string + format: comma-separated + description: 'Sort results using the standard syntax described in [V3 API Standard + Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) + Sorting is supported for the following fields: **displayName, email, usageCount**' + example: -usageCount + - $ref: ../parameters/offset.yaml + - $ref: ../parameters/limit.yaml + - $ref: ../parameters/count.yaml + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Succeeded. Returns a list of source usage for the identities in + a potential role. + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/RoleMiningPotentialRoleSourceUsage.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/role-mining-potential-role-summaries.yaml b/static/api-specs/idn/v2025/paths/role-mining-potential-role-summaries.yaml new file mode 100644 index 000000000..e07cab255 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-mining-potential-role-summaries.yaml @@ -0,0 +1,108 @@ +get: + operationId: getAllPotentialRoleSummaries + summary: Retrieves all potential role summaries + tags: + - IAI Role Mining + description: Returns all potential role summaries that match the query parameters + security: + - userAuth: [] + parameters: + - in: query + name: sorters + required: false + style: form + explode: true + schema: + type: string + format: comma-separated + description: 'Sort results using the standard syntax described in [V3 API Standard + Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **createdDate, identityCount, + entitlementCount, freshness, quality**' + example: createdDate + - in: query + name: filters + description: '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: + + + **createdById**: *eq, sw, co* + + + **createdByName**: *eq, sw, co* + + + **description**: *sw, co* + + + **endDate**: *le, lt* + + + **freshness**: *eq, ge, gt, le, lt* + + + **name**: *eq, sw, co, ge, gt, le, lt* + + + **quality**: *eq, ge, gt, le, lt* + + + **startDate**: *ge, gt* + + + **saved**: *eq* + + + **type**: *eq, ge, gt, le, lt* + + + **scopingMethod**: *eq* + + + **sessionState**: *eq* + + + **identityAttribute**: *co*' + example: (createdByName co "int") and (createdById sw "2c9180907") and (type eq + "COMMON") and ((name co "entt") or (saved eq true)) + required: false + style: form + explode: true + schema: + type: string + - $ref: ../parameters/offset.yaml + - $ref: ../parameters/limit.yaml + - $ref: ../parameters/count.yaml + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Succeeded. Returns all potential role summaries that match the + query parameters. + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/RoleMiningPotentialRoleSummary.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/role-mining-potential-role.yaml b/static/api-specs/idn/v2025/paths/role-mining-potential-role.yaml new file mode 100644 index 000000000..4786d17df --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-mining-potential-role.yaml @@ -0,0 +1,149 @@ +get: + operationId: getRoleMiningPotentialRole + summary: Retrieves a specific potential role + tags: + - IAI Role Mining + description: This method returns a specific potential role. + security: + - userAuth: [] + parameters: + - in: path + name: potentialRoleId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getPotentialRoleSummaries + description: A potential role id + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Succeeded. Returns a list of potential roles for a role mining + session. + content: + application/json: + schema: + $ref: ../schemas/RoleMiningPotentialRole.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml +patch: + operationId: patchPotentialRole + summary: Update a potential role + tags: + - IAI Role Mining + description: 'The method updates an existing potential role using. + + + The following fields can be modified: + + + * `description` + + + * `name` + + + * `saved` + + + + >**NOTE: All other fields cannot be modified.** + + ' + security: + - userAuth: [] + parameters: + - in: path + name: sessionId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getRoleMiningSessions + description: The role mining session id + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - in: path + name: potentialRoleId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getPotentialRoleSummaries + description: The potential role summary id + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + requestBody: + required: true + content: + application/json-patch+json: + schema: + type: array + items: + allOf: + - $ref: ../schemas/JsonPatchOperation.yaml + properties: + op: + type: string + description: The operation to be performed + enum: + - remove + - replace + example: replace + example: + - op: remove + path: /description + - op: replace + path: /description + value: Acct I - Potential Role + - op: remove + path: /saved + - op: replace + path: /saved + value: 'false' + - op: remove + path: /name + - op: replace + path: /name + value: Potential Role Accounting + responses: + '200': + description: Succeeded. Returns the potential role summary based on the potentialRoleId + provided. + content: + application/json: + schema: + type: object + items: + $ref: ../schemas/RoleMiningPotentialRole.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/role-mining-potential-roles-draft.yaml b/static/api-specs/idn/v2025/paths/role-mining-potential-roles-draft.yaml new file mode 100644 index 000000000..ba4cb7ffe --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-mining-potential-roles-draft.yaml @@ -0,0 +1,51 @@ +get: + operationId: getSavedPotentialRoles + summary: Retrieves all saved potential roles + tags: + - IAI Role Mining + description: This method returns all saved potential roles (draft roles). + security: + - userAuth: [] + parameters: + - in: query + name: sorters + required: false + style: form + explode: true + schema: + type: string + format: comma-separated + description: 'Sort results using the standard syntax described in [V3 API Standard + Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) + Sorting is supported for the following fields: **modified**' + example: modified + - $ref: ../parameters/offset.yaml + - $ref: ../parameters/limit.yaml + - $ref: ../parameters/count.yaml + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Succeeded. Returns a list of draft roles for a role mining session. + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/RoleMiningSessionDraftRoleDto.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/role-mining-session-potential-role-applications.yaml b/static/api-specs/idn/v2025/paths/role-mining-session-potential-role-applications.yaml new file mode 100644 index 000000000..b87e29858 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-mining-session-potential-role-applications.yaml @@ -0,0 +1,73 @@ +get: + operationId: getPotentialRoleApplications + summary: Retrieves the applications of a potential role for a role mining session + tags: + - IAI Role Mining + description: This method returns the applications of a potential role for a role + mining session. + parameters: + - in: query + name: filters + schema: + type: string + required: false + description: '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: + + + **applicationName**: *sw*' + example: applicationName sw "test" + - in: path + name: sessionId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getRoleMiningSessions + description: The role mining session id + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - in: path + name: potentialRoleId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getPotentialRoleSummaries + description: A potential role id in a role mining session + example: 62f28d91-7d9f-4d17-be15-666d5b41d77f + - $ref: ../parameters/offset.yaml + - $ref: ../parameters/limit.yaml + - $ref: ../parameters/count.yaml + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Succeeded. Returns a list of potential roles for a role mining + session. + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/RoleMiningPotentialRoleApplication.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: ['iai:access-modeling:read'] + x-sailpoint-userLevels: + - ORG_ADMIN \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/role-mining-session-potential-role-entitlements.yaml b/static/api-specs/idn/v2025/paths/role-mining-session-potential-role-entitlements.yaml new file mode 100644 index 000000000..9d153214a --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-mining-session-potential-role-entitlements.yaml @@ -0,0 +1,73 @@ +get: + operationId: getPotentialRoleEntitlements + summary: Retrieves the entitlements of a potential role for a role mining session + tags: + - IAI Role Mining + description: This method returns the entitlements of a potential role for a role + mining session. + parameters: + - in: query + name: filters + schema: + type: string + required: false + description: '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: + + + **entitlementRef.name**: *sw*' + example: entitlementRef.name sw "test" + - in: path + name: sessionId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getRoleMiningSessions + description: The role mining session id + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - in: path + name: potentialRoleId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getPotentialRoleSummaries + description: A potential role id in a role mining session + example: 62f28d91-7d9f-4d17-be15-666d5b41d77f + - $ref: ../parameters/offset.yaml + - $ref: ../parameters/limit.yaml + - $ref: ../parameters/count.yaml + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Succeeded. Returns the entitlements of a potential role for a role mining session. + session. + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/RoleMiningPotentialRoleEntitlements.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: ['iai:access-modeling:read'] + x-sailpoint-userLevels: + - ORG_ADMIN \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/role-mining-session-potential-role-export-async.yaml b/static/api-specs/idn/v2025/paths/role-mining-session-potential-role-export-async.yaml new file mode 100644 index 000000000..c4149fa81 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-mining-session-potential-role-export-async.yaml @@ -0,0 +1,55 @@ +post: + operationId: exportRoleMiningPotentialRoleAsync + summary: Asynchronously export details for a potential role in a role mining session + and upload to S3 + tags: + - IAI Role Mining + description: This endpoint uploads all the information for a potential role in a + role mining session to S3 as a downloadable zip archive. Includes identities + and entitlements in the potential role. + parameters: + - in: path + name: sessionId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getRoleMiningSessions + description: The role mining session id + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - in: path + name: potentialRoleId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getPotentialRoleSummaries + description: A potential role id in a role mining session + example: 278359a6-04b7-4669-9468-924cf580964a + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + requestBody: + content: + application/json: + schema: + $ref: ../schemas/RoleMiningPotentialRoleExportRequest.yaml + responses: + '202': + description: Job Submitted. Returns a reportId that can be used to download + the zip once complete + content: + application/json: + schema: + $ref: ../schemas/RoleMiningPotentialRoleExportResponse.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/role-mining-session-potential-role-export-download.yaml b/static/api-specs/idn/v2025/paths/role-mining-session-potential-role-export-download.yaml new file mode 100644 index 000000000..d0008793f --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-mining-session-potential-role-export-download.yaml @@ -0,0 +1,60 @@ +get: + operationId: downloadRoleMiningPotentialRoleZip + summary: Export (download) details for a potential role in a role mining session + tags: + - IAI Role Mining + description: This endpoint downloads a completed export of information for a potential + role in a role mining session. + parameters: + - in: path + name: sessionId + schema: + type: string + format: uuid + required: true + x-sailpoint-resource-operation-id: getRoleMiningSessions + description: The role mining session id + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - in: path + name: potentialRoleId + schema: + type: string + format: uuid + required: true + x-sailpoint-resource-operation-id: getPotentialRoleSummaries + description: A potential role id in a role mining session + example: 278359a6-04b7-4669-9468-924cf580964a + - in: path + name: exportId + schema: + type: string + format: uuid + required: true + x-sailpoint-resource-operation-id: exportRoleMiningPotentialRoleAsync + description: The id of a previously run export job for this potential role + example: 4940ffd4-836f-48a3-b2b0-6d498c3fdf40 + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Succeeded. Returns a zip file containing csv files for identities + and entitlements for the potential role. + content: + application/zip: + schema: + type: string + format: binary + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/role-mining-session-potential-role-export-status.yaml b/static/api-specs/idn/v2025/paths/role-mining-session-potential-role-export-status.yaml new file mode 100644 index 000000000..413df41b0 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-mining-session-potential-role-export-status.yaml @@ -0,0 +1,58 @@ +get: + operationId: exportRoleMiningPotentialRoleStatus + summary: Retrieve status of a potential role export job + tags: + - IAI Role Mining + description: This endpoint retrieves information about the current status of a potential + role export. + parameters: + - in: path + name: sessionId + schema: + type: string + format: uuid + required: true + x-sailpoint-resource-operation-id: getRoleMiningSessions + description: The role mining session id + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - in: path + name: potentialRoleId + schema: + type: string + format: uuid + required: true + x-sailpoint-resource-operation-id: getPotentialRoleSummaries + description: A potential role id in a role mining session + example: 278359a6-04b7-4669-9468-924cf580964a + - in: path + name: exportId + schema: + type: string + format: uuid + required: true + x-sailpoint-resource-operation-id: exportRoleMiningPotentialRoleAsync + description: The id of a previously run export job for this potential role + example: 4940ffd4-836f-48a3-b2b0-6d498c3fdf40 + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Success. Returns the current status of this export + content: + application/json: + schema: + $ref: ../schemas/RoleMiningPotentialRoleExportResponse.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/role-mining-session-potential-role-export.yaml b/static/api-specs/idn/v2025/paths/role-mining-session-potential-role-export.yaml new file mode 100644 index 000000000..fcd03c672 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-mining-session-potential-role-export.yaml @@ -0,0 +1,49 @@ +get: + operationId: exportRoleMiningPotentialRole + summary: Export (download) details for a potential role in a role mining session + tags: + - IAI Role Mining + description: This endpoint downloads all the information for a potential role in + a role mining session. Includes identities and entitlements in the potential role. + parameters: + - in: path + name: sessionId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getRoleMiningSessions + description: The role mining session id + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - in: path + name: potentialRoleId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getPotentialRoleSummaries + description: A potential role id in a role mining session + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Succeeded. Returns a zip file containing csv files for identities + and entitlements for the potential role. + content: + application/zip: + schema: + type: string + format: binary + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/role-mining-session-potential-role-summaries.yaml b/static/api-specs/idn/v2025/paths/role-mining-session-potential-role-summaries.yaml new file mode 100644 index 000000000..dece77e33 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-mining-session-potential-role-summaries.yaml @@ -0,0 +1,105 @@ +get: + operationId: getPotentialRoleSummaries + summary: Retrieves all potential role summaries + tags: + - IAI Role Mining + description: This method returns the potential role summaries for a role mining + session. + parameters: + - in: path + name: sessionId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getRoleMiningSessions + description: The role mining session id + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - in: query + name: sorters + required: false + style: form + explode: true + schema: + type: string + format: comma-separated + description: 'Sort results using the standard syntax described in [V3 API Standard + Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **createdDate**' + example: createdDate + - in: query + name: filters + description: '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: + + + **createdById**: *eq, sw, co* + + + **createdByName**: *eq, sw, co* + + + **description**: *sw, co* + + + **endDate**: *le, lt* + + + **freshness**: *eq, ge, gt, le, lt* + + + **name**: *eq, sw, co* + + + **quality**: *eq, ge, gt, le, lt* + + + **startDate**: *ge, gt* + + + **saved**: *eq* + + + **type**: *eq*' + example: (createdByName co "int")and (createdById sw "2c9180907")and (type eq + "COMMON")and ((name co "entt")or (saved eq true)) + required: false + style: form + explode: true + schema: + type: string + - $ref: ../parameters/offset.yaml + - $ref: ../parameters/limit.yaml + - $ref: ../parameters/count.yaml + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Succeeded. Returns a list of potential role summaries for a role + mining session. + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/RoleMiningPotentialRoleSummary.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/role-mining-session-potential-role-summary.yaml b/static/api-specs/idn/v2025/paths/role-mining-session-potential-role-summary.yaml new file mode 100644 index 000000000..85ebe9a72 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-mining-session-potential-role-summary.yaml @@ -0,0 +1,153 @@ +get: + operationId: getPotentialRole + summary: Retrieves a specific potential role + tags: + - IAI Role Mining + description: This method returns a specific potential role for a role mining session. + parameters: + - in: path + name: sessionId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getRoleMiningSessions + description: The role mining session id + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - in: path + name: potentialRoleId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getPotentialRoleSummaries + description: A potential role id in a role mining session + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Succeeded. Returns a list of potential roles for a role mining + session. + content: + application/json: + schema: + $ref: ../schemas/RoleMiningPotentialRole.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml +patch: + operationId: patchPotentialRole + summary: Update a potential role + tags: + - IAI Role Mining + description: 'The method updates an existing potential role using. + + + The following fields can be modified: + + + * `description` + + + * `name` + + + * `saved` + + + + >**NOTE: All other fields cannot be modified.** + + ' + parameters: + - in: path + name: sessionId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getRoleMiningSessions + description: The role mining session id + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - in: path + name: potentialRoleId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getPotentialRoleSummaries + description: The potential role summary id + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + requestBody: + required: true + content: + application/json-patch+json: + schema: + type: array + items: + allOf: + - $ref: ../schemas/JsonPatchOperation.yaml + properties: + op: + type: string + description: The operation to be performed + enum: + - remove + - replace + example: replace + example: + - op: remove + path: /description + - op: replace + path: /description + value: Acct I - Potential Role + - op: remove + path: /saved + - op: replace + path: /saved + value: 'false' + - op: remove + path: /name + - op: replace + path: /name + value: Potential Role Accounting + responses: + '200': + description: Succeeded. Returns the potential role summary based on the potentialRoleId + provided. + content: + application/json: + schema: + type: object + items: + $ref: ../schemas/RoleMiningPotentialRole.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/role-mining-session-status.yaml b/static/api-specs/idn/v2025/paths/role-mining-session-status.yaml new file mode 100644 index 000000000..7bfa445d7 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-mining-session-status.yaml @@ -0,0 +1,38 @@ +get: + operationId: getRoleMiningSessionStatus + summary: Get role mining session status state + tags: + - IAI Role Mining + description: This method returns a role mining session status for a customer. + parameters: + - in: path + name: sessionId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getRoleMiningSessions + description: The role mining session id + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Succeeded. Returns session status + content: + application/json: + schema: + $ref: ../schemas/RoleMiningSessionStatus.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/role-mining-session.yaml b/static/api-specs/idn/v2025/paths/role-mining-session.yaml new file mode 100644 index 000000000..8b6c64595 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-mining-session.yaml @@ -0,0 +1,109 @@ +patch: + operationId: patchRoleMiningSession + summary: Patch a role mining session + tags: + - IAI Role Mining + description: The method updates an existing role mining session using PATCH. Supports + op in {"replace"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. + The potential roles in this role mining session is then re-calculated. + parameters: + - in: path + name: sessionId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getRoleMiningSessions + description: The role mining session id to be patched + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + requestBody: + required: true + description: Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in + role mining session. Update saved status or saved name for a role mining session. + content: + application/json-patch+json: + schema: + type: array + items: + $ref: ../schemas/JsonPatchOperation.yaml + example: + - op: replace + path: /pruneThreshold + value: '83' + - op: replace + path: /minNumIdentitiesInPotentialRole + value: '10' + - op: replace + path: /saved + value: 'false' + - op: replace + path: /name + value: RM Session - 07/10/22 + - op: add + path: /name + value: RM Session - 07/10/22 + responses: + '202': + description: Success + $ref: ../responses/202.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml +get: + operationId: getRoleMiningSession + summary: Get a role mining session + tags: + - IAI Role Mining + description: The method retrieves a role mining session. + parameters: + - in: path + name: sessionId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getRoleMiningSessions + description: The role mining session id to be retrieved. + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Returns a role mining session + content: + application/json: + schema: + $ref: ../schemas/RoleMiningSessionResponse.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/400.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/role-mining-sessions.yaml b/static/api-specs/idn/v2025/paths/role-mining-sessions.yaml new file mode 100644 index 000000000..6ac47adcd --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role-mining-sessions.yaml @@ -0,0 +1,105 @@ +post: + operationId: createRoleMiningSessions + summary: Create a role mining session + tags: + - IAI Role Mining + description: This submits a create role mining session request to the role mining + application. + requestBody: + description: Role mining session parameters + required: true + content: + application/json: + schema: + $ref: ../schemas/RoleMiningSessionDto.yaml + responses: + '201': + description: Submitted a role mining session request + content: + application/json: + schema: + $ref: ../schemas/RoleMiningSessionResponse.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true +get: + operationId: getRoleMiningSessions + summary: Retrieves all role mining sessions + tags: + - IAI Role Mining + description: Returns all role mining sessions that match the query parameters + parameters: + - in: query + name: filters + schema: + type: string + description: '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: + + + **saved**: *eq* + + + **name**: *eq, sw*' + example: saved eq "true" and name sw "RM Session" + - in: query + name: sorters + schema: + type: string + format: comma-separated + description: 'Sort results using the standard syntax described in [V3 API Standard + Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **createdBy, createdDate**' + example: createdBy,createdDate + - $ref: ../parameters/offset.yaml + - $ref: ../parameters/limit.yaml + - $ref: ../parameters/count.yaml + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Succeeded. Returns all role mining sessions that match the query + parameters. + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/RoleMiningSessionDto.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/role.yaml b/static/api-specs/idn/v2025/paths/role.yaml new file mode 100644 index 000000000..45126fecb --- /dev/null +++ b/static/api-specs/idn/v2025/paths/role.yaml @@ -0,0 +1,317 @@ +get: + operationId: getRole + tags: + - Roles + summary: Get a Role + description: >- + This API returns a Role by its ID. + + A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a + token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated + to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + parameters: + - in: path + name: id + required: true + x-sailpoint-resource-operation-id: listRoles + schema: + type: string + description: >- + ID of the Role + example: 2c91808a7813090a017814121e121518 + responses: + '200': + description: List of all Roles + content: + application/json: + schema: + $ref: '../schemas/access/Role.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + security: + - userAuth: [ idn:role-unchecked:read, idn:role-unchecked:manage, idn:role-checked:manage, idn:role-checked:read ] + x-sailpoint-userLevels: + - ORG_ADMIN + - ROLE_ADMIN + - ROLE_SUBADMIN +patch: + operationId: patchRole + tags: + - Roles + summary: Patch a specified Role + description: >- + This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + + + The following fields are patchable: + + + * name + + * description + + * enabled + + * owner + + * accessProfiles + + * entitlements + + * membership + + * requestable + + * accessRequestConfig + + * revokeRequestConfig + + * segments + + * accessModelMetadata + + A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a + token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated + to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + + + The maximum supported length for the description field is 2000 characters. + Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. + + + When you use this API to modify a role's membership identities, you can only modify up to a limit of 500 membership identities at a time. + parameters: + - name: id + in: path + description: ID of the Role to patch + required: true + x-sailpoint-resource-operation-id: listRoles + schema: + type: string + example: 2c91808a7813090a017814121e121518 + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: '../schemas/JsonPatchOperation.yaml' + examples: + Make a Role Requestable and Enable it in One Call: + description: This example shows how multiple fields may be updated with a single patch call. + value: + [ + { + "op": "replace", + "path": "/requestable", + "value": true + }, + { + "op": "replace", + "path": "/enabled", + "value": true + } + ] + + Assign a Role to a Segment: + description: >- + This example illustrates the use of patch to assign a Role to a Segment by adding the Segment's ID to the + Role's segments array. + value: + [ + { + "op": "add", + "path": "/segments/-", + "value": "f7b1b8a3-5fed-4fd4-ad29-82014e137e19" + } + ] + + Set the Membership Selection Criteria to a List of Identities: + description: >- + This example shows how to define a Role's membershp by providing a list of Identities, referenced by their + IDs. + value: + [ + { + "op": "replace", + "path": "/membership", + "value": { + "type": "IDENTITY_LIST", + "identities": [ + { + "id": "2c91808973fe906c0174262092014ed9" + }, + { + "id": "2c918086262092014ed94fb8a47612f3" + } + ] + } + } + ] + + Set the Membership Selection Criteria to a Standard Expression: + description: >- + This example shows how to define a Role's membership using STANDARD criteria. In this case, the Role + will be granted to all Identities which have the *Engineering* attribute from the indicated Source. + value: + [ + { + "op": "replace", + "path": "/membership", + "value": { + "type": "STANDARD", + "criteria": { + "operation": "OR", + "children": [ + { + "operation": "EQUALS", + "key": { + "type": "ENTITLEMENT", + "property": "attribute.memberOf", + "sourceId": "2c9180887701fb2014213e122092014e" + }, + "stringValue": "Engineering" + } + ] + } + } + } + ] + + Add a New Clause as the Child of an Existing Standard Expression: + description: >- + This example shows how to add a child clause to an existing STANDARD criteria expression. + value: + [ + { + "op": "add", + "path": "/membership/criteria/children/-", + "value": { + "operation": "ENDS_WITH", + "key": { + "type": "IDENTITY", + "property": "attribute.email" + }, + "stringValue": "@identitynow.com" + } + } + ] + + Assign a Access Model Metadata to a Role: + description: This example shows how to assign a existing metadata to a role. + value: + [ + { + "op": "add", + "path": "/accessModelMetadata/attributes/0", + "value": { + "key": "iscFederalClassifications", + "values": [ + { + "value": "secret" + } + ] + } + } + ] + + Add an Access Profile to a Role: + description: This example shows how to add an access profile to a role. + value: + [ + { + "op": "add", + "path": "/accessProfiles/-", + "value": { + "id": "1de104e1f9024b1289b3a31e22d28cd1", + "type": "ACCESS_PROFILE" + } + } + ] + + Add an Entitlement to a Role: + description: This example shows how to add an entitlement to a role. + value: + [ + { + "op": "add", + "path": "/entitlements/-", + "value": { + "id": "0fb2f8051e48421b8f1f8a64aee3b205", + "type": "ENTITLEMENT" + } + } + ] + required: true + responses: + '200': + description: Responds with the Role as updated. + content: + application/json: + schema: + $ref: '../schemas/access/Role.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + security: + - userAuth: [idn:role-unchecked:manage,idn:role-checked:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + - ROLE_ADMIN + - ROLE_SUBADMIN +delete: + operationId: deleteRole + tags: + - Roles + summary: Delete a Role + description: >- + This API deletes a Role by its ID. + + + A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a + token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated + to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + parameters: + - in: path + name: id + required: true + x-sailpoint-resource-operation-id: listRoles + schema: + type: string + description: >- + ID of the Role + example: 2c91808a7813090a017814121e121518 + responses: + '204': + $ref: "../responses/204.yaml" + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + security: + - userAuth: [ idn:role-unchecked:manage,idn:role-checked:manage ] + x-sailpoint-userLevels: + - ORG_ADMIN + - ROLE_ADMIN + - ROLE_SUBADMIN \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/roles-by-identity.yaml b/static/api-specs/idn/v2025/paths/roles-by-identity.yaml new file mode 100644 index 000000000..1eada6180 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/roles-by-identity.yaml @@ -0,0 +1,42 @@ +get: + operationId: getRolesByIdentity + tags: + - Roles + summary: Roles assigned to Identity + description: >- + This API returns a list of Roles assigned to Identity. + + + Any authenticated user can read their own roles. Otherwise, a token with API, ORG_ADMIN, DASHBOARD, REPORT_ADMIN, + CLOUD_GOV_ADMIN, or CLOUD_GOV_USER authority is required to call this API. + parameters: + - in: path + name: id + schema: + type: string + description: >- + ID of the Identity for which the assigned Roles are to be listed + example: 2c9180857dc9900e017dd3a36e1c3ab8 + required: true + x-sailpoint-resource-operation-id: listIdentities + responses: + '200': + description: List of Roles + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/access/Role.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + security: + - userAuth: [idn:identity:read, idn:identity:manage, idn:identity-account-read, idn:identity-self:read] diff --git a/static/api-specs/idn/v2025/paths/roles.yaml b/static/api-specs/idn/v2025/paths/roles.yaml new file mode 100644 index 000000000..4aa02ed36 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/roles.yaml @@ -0,0 +1,165 @@ +get: + operationId: listRoles + tags: + - Roles + summary: List Roles + description: >- + This API returns a list of Roles. + + + A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to + call this API. + parameters: + - in: query + name: for-subadmin + schema: + type: string + description: >- + If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. + The value of the parameter is either an Identity ID, or the special value **me**, + which is shorthand for the calling Identity's ID. + A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not + a subadmin. + example: 5168015d32f890ca15812c9180835d2e + required: false + - $ref: '../parameters/limit50.yaml' + - $ref: '../parameters/offset.yaml' + - $ref: '../parameters/count.yaml' + - in: query + name: filters + schema: + type: string + description: >- + Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) + + + Filtering is supported for the following fields and operators: + + + **id**: *eq, in* + + + **name**: *eq, sw* + + + **created**: *gt, lt, ge, le* + + + **modified**: *gt, lt, ge, le* + + + **owner.id**: *eq, in* + + + **requestable**: *eq* + example: requestable eq false + required: false + - in: query + name: sorters + schema: + type: string + format: comma-separated + description: >- + Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **name, created, modified** + example: name,-modified + required: false + - in: query + name: for-segment-ids + schema: + type: string + format: comma-separated + description: >- + If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) + with the specified IDs. + + + If segmentation is currently unavailable, specifying this parameter results in an error. + example: 0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d + required: false + - in: query + name: include-unsegmented + schema: + type: boolean + default: true + description: >- + Whether or not the response list should contain unsegmented Roles. + If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. + example: false + required: false + responses: + '200': + description: List of Roles + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/access/Role.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + security: + - userAuth: [idn:role-unchecked:read, idn:role-unchecked:manage, idn:role-checked:manage, idn:role-checked:read] + x-sailpoint-userLevels: + - ORG_ADMIN + - ROLE_ADMIN + - ROLE_SUBADMIN + +post: + operationId: createRole + tags: + - Roles + summary: Create a Role + description: >- + This API creates a role. + + + You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to + call this API. + + + In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile + is associated with a source the ROLE_SUBADMIN is not associated with themselves. + + + The maximum supported length for the description field is 2000 characters. + Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/access/Role.yaml' + responses: + '201': + description: Role created + content: + application/json: + schema: + $ref: '../schemas/access/Role.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + security: + - userAuth: [idn:role-unchecked:manage, idn:role-checked:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + - ROLE_ADMIN + - ROLE_SUBADMIN diff --git a/static/api-specs/idn/v2025/paths/run-datapipeline-dagid.yaml b/static/api-specs/idn/v2025/paths/run-datapipeline-dagid.yaml new file mode 100644 index 000000000..9b754b0e0 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/run-datapipeline-dagid.yaml @@ -0,0 +1,43 @@ +post: + operationId: runDataPipelineByDagId + tags: + - IAI Data Pipeline + summary: Run a specific data pipeline dag by dag id + description: >- + This starts a specific type of data pipeline dag by dag id. + + Requires security scope of 'iai:data-pipeline:run'. + + parameters: + - in: path + name: type + schema: + type: string + enum: + - PGA + - STREAMING + required: true + description: The data pipeline type + example: STREAMING + - in: path + name: id + schema: + type: string + required: true + description: The dag id + example: 'airflow-dag-1' + responses: + '202': + $ref: '../responses/202.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '500': + $ref: '../responses/500.yaml' + # security: + # - oauth2: [iai:data-pipeline:run] diff --git a/static/api-specs/idn/v2025/paths/run-datapipeline-dagtype.yaml b/static/api-specs/idn/v2025/paths/run-datapipeline-dagtype.yaml new file mode 100644 index 000000000..bdb93a39c --- /dev/null +++ b/static/api-specs/idn/v2025/paths/run-datapipeline-dagtype.yaml @@ -0,0 +1,35 @@ +post: + operationId: runDataPipelineByType + tags: + - IAI Data Pipeline + summary: Run a specific data pipeline dag for a customer by data pipeline type + description: >- + This starts a latest data pipeline dag based on previous dags execution date for a customer by data pipeline type. + + Requires security scope of 'iai:data-pipeline:run'. + parameters: + - in: path + name: type + schema: + type: string + enum: + - PGA + - STREAMING + required: true + description: The data pipeline type + example: STREAMING + responses: + '202': + $ref: '../responses/202.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '500': + $ref: '../responses/500.yaml' + # security: + # - oauth2: [iai:data-pipeline:run] diff --git a/static/api-specs/idn/v2025/paths/s3-proxy.yaml b/static/api-specs/idn/v2025/paths/s3-proxy.yaml new file mode 100644 index 000000000..bcf48900f --- /dev/null +++ b/static/api-specs/idn/v2025/paths/s3-proxy.yaml @@ -0,0 +1,51 @@ +get: + operationId: s3Proxy + summary: Retrieves an artifact from S3. + tags: + - S3 Access + description: >- + Accepts a path from S3 and the bucket type either shared or org. The bucket in which the artifact resides is provided + to the runtime service by an environment variable controlled by devops. This is also true for the S3 creds as they + are available to the service at runtime. + + If the bucket type is shared, no further validation is needed. If the bucket type is org, the information in the JWT + is validated against the path query parameter. A token with API authority is required to access this endpoint.. + + security: + - userAuth: [idn:s3-proxy:read] + parameters: + - in: query + name: path + schema: + type: string + required: true + description: The path to the S3 artifact minus the bucket. + example: /xxx/yyy/zzz/filename + - in: query + name: bucket-type + schema: + type: string + enum: [ORG, SHARED] + required: true + description: The type of bucket either shared or org. + example: SHARED + responses: + '200': + description: Requested file + content: + application/octet-stream: + schema: + type: string + format: binary + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/saas-management-application-for-source.yaml b/static/api-specs/idn/v2025/paths/saas-management-application-for-source.yaml new file mode 100644 index 000000000..92f98ab88 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/saas-management-application-for-source.yaml @@ -0,0 +1,37 @@ +get: + operationId: getApplicationForSource + tags: + - SaaS Management + summary: SaaS Management Application for source + description: >- + This API returns the mapped SaaS Management application for an IdentityNow source ID or 404 if not mapped. + + A token with ORG_ADMIN, SOURCE_ADMIN or SOURCE_SUBADMIN authority is required to call this API. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSources + description: The IdentityNow source ID + example: 2c9180866166b5b0016167c32ef31a66 + responses: + '200': + description: SaaS Management application for source, if source is mapped. + content: + application/json: + schema: + $ref: '../../beta/schemas/SaasManagementApplication.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/saas-management-applications-test.yaml b/static/api-specs/idn/v2025/paths/saas-management-applications-test.yaml new file mode 100644 index 000000000..5a666a6f5 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/saas-management-applications-test.yaml @@ -0,0 +1,38 @@ +post: + operationId: testApplicationMapping + tags: + - SaaS Management + summary: Test SaaS Management Application mapping + description: >- + This API tests if accounts on IdentityNow match those on the mapped SaaS Management Application, + or 404 if not mapped. + + A token with ORG_ADMIN, SOURCE_ADMIN or SOURCE_SUBADMIN authority is required to call this API. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSources + description: The IdentityNow source ID + example: 2c9180866166b5b0016167c32ef31a66 + responses: + '200': + description: SaaS Management application object with the updated test result. + content: + application/json: + schema: + $ref: '../../beta/schemas/SaasManagementApplication.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/saas-management-applications-update-map.yaml b/static/api-specs/idn/v2025/paths/saas-management-applications-update-map.yaml new file mode 100644 index 000000000..9812fb3d2 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/saas-management-applications-update-map.yaml @@ -0,0 +1,39 @@ +post: + operationId: updateApplicationsMap + tags: + - SaaS Management + summary: Update SaaS Management Application mapping + description: >- + This API updates SaaS Management Application mappings to IdentityNow sources. + + A token with ORG_ADMIN, SOURCE_ADMIN or SOURCE_SUBADMIN authority is required to call this API. + requestBody: + required: true + description: One or more mappings to update. + content: + application/json: + schema: + type: array + items: + $ref: '../../beta/schemas/SaasManagementApplicationMap.yaml' + responses: + '200': + description: Updated SaaS Management application objects. + content: + application/json: + schema: + type: array + items: + $ref: '../../beta/schemas/SaasManagementApplication.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/saas-management-applications.yaml b/static/api-specs/idn/v2025/paths/saas-management-applications.yaml new file mode 100644 index 000000000..01d6c2f92 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/saas-management-applications.yaml @@ -0,0 +1,54 @@ +get: + operationId: listApplications + tags: + - SaaS Management + summary: SaaS Management Applications + description: >- + This API returns a list of SaaS Management applications sorted by name that satisfy the given query parameters. + + A token with ORG_ADMIN, SOURCE_ADMIN or SOURCE_SUBADMIN authority is required to call this API. + parameters: + - in: query + name: filters + schema: + type: string + description: >- + Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) + + + Filtering is supported for the following fields and operators: + + + **id**: *eq, in* + + + **name**: *eq, co, sw* + + + **integrationType**: *eq, in* + + + **integrationState**: *eq, in* + example: id eq "" + - $ref: '../parameters/limit.yaml' + - $ref: '../parameters/offset.yaml' + - $ref: '../parameters/count.yaml' + responses: + '200': + description: List of SaaS Management applications + content: + application/json: + schema: + type: array + items: + $ref: '../../beta/schemas/SaasManagementApplication.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/saved-searches-execute.yaml b/static/api-specs/idn/v2025/paths/saved-searches-execute.yaml new file mode 100644 index 000000000..fb105ac6d --- /dev/null +++ b/static/api-specs/idn/v2025/paths/saved-searches-execute.yaml @@ -0,0 +1,39 @@ +post: + tags: + - Saved Search + description: | + Executes the specified saved search. + summary: Execute a saved search by ID + operationId: executeSavedSearch + parameters: + - $ref: '../parameters/path/search/id.yaml' + requestBody: + description: | + When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. + + If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. + content: + application/json: + schema: + $ref: '../schemas/search/saved/SearchArguments.yaml' + examples: + scheduled: + $ref: '../schemas/search/saved/examples/execute-scheduled.yaml' + test: + $ref: '../schemas/search/saved/examples/execute-test.yaml' + required: true + responses: + '202': + description: Accepted - Returned if the request was successfully accepted into the system. + '404': + $ref: '../responses/404.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/saved-searches-id.yaml b/static/api-specs/idn/v2025/paths/saved-searches-id.yaml new file mode 100644 index 000000000..be02c8b16 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/saved-searches-id.yaml @@ -0,0 +1,109 @@ +put: + tags: + - Saved Search + description: | + Updates an existing saved search. + + >**NOTE: You cannot update the `owner` of the saved search.** + summary: | + Updates an existing saved search + operationId: putSavedSearch + parameters: + - in: path + name: id + description: ID of the requested document. + schema: + type: string + required: true + example: 2c91808568c529c60168cca6f90c1313 + x-sailpoint-resource-operation-id: listSavedSearches + requestBody: + description: The saved search to persist. + content: + application/json: + schema: + $ref: '../schemas/search/saved/SavedSearch.yaml' + required: true + responses: + '200': + description: The persisted saved search. + content: + application/json: + schema: + $ref: '../schemas/search/saved/SavedSearch.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +get: + tags: + - Saved Search + description: | + Returns the specified saved search. + summary: Return saved search by ID + operationId: getSavedSearch + parameters: + - in: path + name: id + description: ID of the requested document. + schema: + type: string + required: true + example: 2c91808568c529c60168cca6f90c1313 + x-sailpoint-resource-operation-id: listSavedSearches + responses: + '200': + description: The requested saved search. + content: + application/json: + schema: + $ref: '../schemas/search/saved/SavedSearch.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +delete: + tags: + - Saved Search + description: | + Deletes the specified saved search. + summary: Delete document by ID + operationId: deleteSavedSearch + parameters: + - in: path + name: id + description: ID of the requested document. + schema: + type: string + required: true + example: 2c91808568c529c60168cca6f90c1313 + x-sailpoint-resource-operation-id: listSavedSearches + responses: + '204': + description: No Content - Indicates the request was successful but there is no content to be returned in the response. + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/saved-searches.yaml b/static/api-specs/idn/v2025/paths/saved-searches.yaml new file mode 100644 index 000000000..c36dd4afd --- /dev/null +++ b/static/api-specs/idn/v2025/paths/saved-searches.yaml @@ -0,0 +1,86 @@ +post: + security: + - userAuth: [sp:saved-search:create] + tags: + - Saved Search + description: | + Creates a new saved search. + summary: Create a saved search + operationId: createSavedSearch + requestBody: + description: The saved search to persist. + content: + application/json: + schema: + allOf: + - $ref: '../schemas/search/saved/SavedSearchName.yaml' + - $ref: '../schemas/search/saved/SavedSearchDetail.yaml' + required: true + responses: + '201': + description: The persisted saved search. + content: + application/json: + schema: + $ref: '../schemas/search/saved/SavedSearch.yaml' + '400': + $ref: '../responses/400.yaml' + "401": + $ref: "../responses/401.yaml" + "403": + $ref: "../responses/403.yaml" + "429": + $ref: "../responses/429.yaml" + "500": + $ref: "../responses/500.yaml" +get: + security: + - userAuth: [sp:saved-search:read] + tags: + - Saved Search + description: | + Returns a list of saved searches. + summary: A list of Saved Searches + operationId: listSavedSearches + parameters: + - $ref: '../parameters/offset.yaml' + - $ref: '../parameters/limit.yaml' + - $ref: '../parameters/count.yaml' + - name: filters + in: query + schema: + type: string + description: >- + 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: + + + **owner.id**: *eq* + example: owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8" + responses: + '200': + description: The list of requested saved searches. + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/search/saved/SavedSearch.yaml' + headers: + X-Total-Count: + description: The total result count (returned only if the *count* parameter is specified as *true*). + schema: + type: integer + example: 5 + '400': + $ref: '../responses/400.yaml' + "401": + $ref: "../responses/401.yaml" + "403": + $ref: "../responses/403.yaml" + "429": + $ref: "../responses/429.yaml" + "500": + $ref: "../responses/500.yaml" diff --git a/static/api-specs/idn/v2025/paths/scheduled-actions-bulk-delete.yaml b/static/api-specs/idn/v2025/paths/scheduled-actions-bulk-delete.yaml new file mode 100644 index 000000000..84c053456 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/scheduled-actions-bulk-delete.yaml @@ -0,0 +1,41 @@ +post: + operationId: bulkDeleteScheduledActions + tags: + - SP-Scheduler + summary: Bulk Delete Scheduled Actions + description: >- + This deletes a list of scheduled actions filtered by meta data. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + meta: + type: object + description: Key value pair to query the meta data field provided when actions are created. + example: {"flag": true} + responses: + '200': + description: >- + A list of scheduled action objects. + content: + application/json: + schema: + type: object + properties: + count: + type: integer + description: The amount of scheduled actions that were deleted. + example: 2 + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/scheduled-actions-delete.yaml b/static/api-specs/idn/v2025/paths/scheduled-actions-delete.yaml new file mode 100644 index 000000000..151f4878a --- /dev/null +++ b/static/api-specs/idn/v2025/paths/scheduled-actions-delete.yaml @@ -0,0 +1,30 @@ +delete: + operationId: deleteScheduledActions + tags: + - SP-Scheduler + summary: Delete Scheduled Actions + description: >- + This deletes a scheduled action by id + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listScheduledActions + description: The scheduled action id + example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + responses: + '204': + $ref: '../responses/204.yaml' + description: The scheduled action was successfully deleted. + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/scheduled-actions.yaml b/static/api-specs/idn/v2025/paths/scheduled-actions.yaml new file mode 100644 index 000000000..5c1f5e032 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/scheduled-actions.yaml @@ -0,0 +1,73 @@ +get: + operationId: listScheduledActions + tags: + - SP-Scheduler + summary: List Scheduled Actions + description: >- + This gets a list of scheduled actions filtered by query parameters and meta data. + parameters: + - $ref: '../parameters/limit.yaml' + - $ref: '../parameters/offset.yaml' + - in: query + name: filters + schema: + type: string + description: >- + 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: + + + **meta**: *eq* + responses: + '200': + description: >- + A list of scheduled action objects. + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/ScheduledAction.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +post: + operationId: createScheduledActions + tags: + - SP-Scheduler + summary: Create Scheduled Actions + description: >- + This creates a scheduled action with a deadline that it needs to be fired. + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/ScheduledAction.yaml' + responses: + '200': + description: >- + A scheduled action object. + content: + application/json: + schema: + $ref: '../schemas/ScheduledAction.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/scheduled-searches-id.yaml b/static/api-specs/idn/v2025/paths/scheduled-searches-id.yaml new file mode 100644 index 000000000..878ec708c --- /dev/null +++ b/static/api-specs/idn/v2025/paths/scheduled-searches-id.yaml @@ -0,0 +1,107 @@ +put: + tags: + - Scheduled Search + description: | + Updates an existing scheduled search. + summary: Update an existing Scheduled Search + operationId: updateScheduledSearch + parameters: + - in: path + name: id + description: ID of the requested document. + schema: + type: string + required: true + example: 2c91808568c529c60168cca6f90c1313 + x-sailpoint-resource-operation-id: listScheduledSearch + requestBody: + description: The scheduled search to persist. + content: + application/json: + schema: + $ref: '../schemas/search/scheduled/ScheduledSearch.yaml' + required: true + responses: + '200': + description: The persisted scheduled search. + content: + application/json: + schema: + $ref: '../schemas/search/scheduled/ScheduledSearch.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +get: + tags: + - Scheduled Search + description: Returns the specified scheduled search. + summary: Get a Scheduled Search + operationId: getScheduledSearch + parameters: + - in: path + name: id + description: ID of the requested document. + schema: + type: string + required: true + example: 2c91808568c529c60168cca6f90c1313 + x-sailpoint-resource-operation-id: listScheduledSearch + responses: + '200': + description: The requested scheduled search. + content: + application/json: + schema: + $ref: '../schemas/search/scheduled/ScheduledSearch.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +delete: + tags: + - Scheduled Search + description: | + Deletes the specified scheduled search. + operationId: deleteScheduledSearch + summary: Delete a Scheduled Search + parameters: + - in: path + name: id + description: ID of the requested document. + schema: + type: string + required: true + example: 2c91808568c529c60168cca6f90c1313 + x-sailpoint-resource-operation-id: listScheduledSearch + responses: + '204': + description: No Content - Indicates the request was successful but there is no content to be returned in the response. + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/scheduled-searches-unsubscribe.yaml b/static/api-specs/idn/v2025/paths/scheduled-searches-unsubscribe.yaml new file mode 100644 index 000000000..e9b45bfed --- /dev/null +++ b/static/api-specs/idn/v2025/paths/scheduled-searches-unsubscribe.yaml @@ -0,0 +1,26 @@ +post: + tags: + - Scheduled Search + description: | + Unsubscribes a recipient from the specified scheduled search. + operationId: unsubscribeScheduledSearch + summary: Unsubscribe a recipient from Scheduled Search + parameters: + - $ref: '../parameters/path/search/id.yaml' + requestBody: + description: | + The recipient to be removed from the scheduled search. + content: + application/json: + schema: + $ref: '../schemas/search/model/base/TypedReference.yaml' + required: true + responses: + '204': + description: No Content - Indicates the request was successful but there is no content to be returned in the response. + '400': + $ref: '../responses/400.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' diff --git a/static/api-specs/idn/v2025/paths/scheduled-searches.yaml b/static/api-specs/idn/v2025/paths/scheduled-searches.yaml new file mode 100644 index 000000000..0b74c4aea --- /dev/null +++ b/static/api-specs/idn/v2025/paths/scheduled-searches.yaml @@ -0,0 +1,239 @@ +post: + tags: + - Scheduled Search + description: | + Creates a new scheduled search. + summary: Create a new scheduled search + operationId: createScheduledSearch + requestBody: + description: The scheduled search to persist. + content: + application/json: + schema: + allOf: + - $ref: '../schemas/search/scheduled/ScheduledSearchName.yaml' + - $ref: '../schemas/search/scheduled/SearchSchedule.yaml' + examples: + Daily Search: + description: A search that executes each day at a 9 AM + value: + { + "savedSearchId": "9c620e13-cd33-4804-a13d-403bd7bcdbad", + "schedule": { + "type": "DAILY", + "hours": { + "type": "LIST", + "values": [ + "9" + ] + } + }, + "recipients": [ + { + "type": "IDENTITY", + "id": "2c9180867624cbd7017642d8c8c81f67" + } + ] + } + Weekly Search: + description: A search that executes each week on select days and times + value: + { + "savedSearchId": "9c620e13-cd33-4804-a13d-403bd7bcdbad", + "schedule": { + "type": "WEEKLY", + "days": { + "type": "LIST", + "values": [ + "MON", + "TUE", + "WED", + "THU", + "FRI", + "SAT", + "SUN" + ] + }, + "hours": { + "type": "LIST", + "values": [ + "9" + ] + } + }, + "recipients": [ + { + "type": "IDENTITY", + "id": "2c9180867624cbd7017642d8c8c81f67" + } + ] + } + Monthly Search: + description: A search that executes each month on select days and times + value: + { + "savedSearchId": "9c620e13-cd33-4804-a13d-403bd7bcdbad", + "schedule": { + "type": "MONTHLY", + "days": { + "type": "LIST", + "values": [ + "1", + "7", + "14", + "L" + ] + }, + "hours": { + "type": "LIST", + "values": [ + "9" + ] + } + }, + "recipients": [ + { + "type": "IDENTITY", + "id": "2c9180867624cbd7017642d8c8c81f67" + } + ] + } + Annual Search: + description: A search that executes each year on the defined months, days, and times. + value: + { + "savedSearchId": "9c620e13-cd33-4804-a13d-403bd7bcdbad", + "schedule": { + "type": "ANNUALLY", + "months": { + "type": "LIST", + "values": [ + "1" + ], + "interval": 3 + }, + "days": { + "type": "LIST", + "values": [ + "1", + "7", + "14", + "L" + ] + }, + "hours": { + "type": "LIST", + "values": [ + "9" + ] + } + }, + "recipients": [ + { + "type": "IDENTITY", + "id": "2c9180867624cbd7017642d8c8c81f67" + } + ] + } + Calendar Search: + description: A search that executes on specific calendar days + value: + { + "savedSearchId": "9c620e13-cd33-4804-a13d-403bd7bcdbad", + "schedule": { + "type": "CALENDAR", + "days": { + "type": "LIST", + "values": [ + "2023-01-22", + "2023-02-22" + ] + }, + "hours": { + "type": "LIST", + "values": [ + "9" + ] + } + }, + "recipients": [ + { + "type": "IDENTITY", + "id": "2c9180867624cbd7017642d8c8c81f67" + } + ] + } + required: true + responses: + '201': + description: The persisted scheduled search. + content: + application/json: + schema: + $ref: '../schemas/search/scheduled/ScheduledSearch.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +get: + tags: + - Scheduled Search + description: | + Returns a list of scheduled searches. + summary: List scheduled searches + operationId: listScheduledSearch + parameters: + - $ref: '../parameters/offset.yaml' + - $ref: '../parameters/limit.yaml' + - $ref: '../parameters/count.yaml' + - name: filters + in: query + schema: + type: string + description: >- + 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: + + + **owner.id**: *eq* + + + **savedSearchId**: *eq* + example: savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e" + responses: + '200': + description: The list of requested scheduled searches. + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/search/scheduled/ScheduledSearch.yaml' + headers: + X-Total-Count: + description: The total result count (returned only if the *count* parameter is specified as *true*). + schema: + type: integer + example: 5 + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/schema.yaml b/static/api-specs/idn/v2025/paths/schema.yaml new file mode 100644 index 000000000..36d30ebcc --- /dev/null +++ b/static/api-specs/idn/v2025/paths/schema.yaml @@ -0,0 +1,238 @@ + +get: + operationId: getSourceSchema + tags: + - Sources + summary: Get Source Schema by ID + description: | + Get the Source Schema by ID in IdentityNow. + parameters: + - in: path + name: sourceId + required: true + x-sailpoint-resource-operation-id: listSources + schema: + type: string + description: The Source id. + example: 2c9180835d191a86015d28455b4a2329 + - in: path + name: schemaId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getSourceSchemas + description: The Schema id. + example: 2c9180835d191a86015d28455b4a2329 + responses: + '200': + description: The requested Schema was successfully retrieved. + content: + application/json: + schema: + $ref: '../schemas/Schema.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +put: + operationId: putSourceSchema + tags: + - Sources + summary: Update Source Schema (Full) + description: | + This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. + + * id + * name + * created + * modified + + Any attempt to modify these fields will result in an error response with a status code of 400. + + > `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. + parameters: + - in: path + name: sourceId + required: true + x-sailpoint-resource-operation-id: listSources + schema: + type: string + description: The Source id. + example: 2c9180835d191a86015d28455b4a2329 + - in: path + name: schemaId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getSourceSchemas + description: The Schema id. + example: 2c9180835d191a86015d28455b4a2329 + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/Schema.yaml' + responses: + '200': + description: The Schema was successfully replaced. + content: + application/json: + schema: + $ref: '../schemas/Schema.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +patch: + operationId: updateSourceSchema + tags: + - Sources + summary: Update Source Schema (Partial) + description: | + Use this API to selectively update an existing Schema using a JSONPatch payload. + + The following schema fields are immutable and cannot be updated: + + - id + - name + - created + - modified + + + To switch an account attribute to a group entitlement, you need to have the following in place: + + - `isEntitlement: true` + - Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: + ```json + { + "name": "groups", + "type": "STRING", + "schema": { + "type": "CONNECTOR_SCHEMA", + "id": "2c9180887671ff8c01767b4671fc7d60", + "name": "group" + }, + "description": "The groups, roles etc. that reference account group objects", + "isMulti": true, + "isEntitlement": true, + "isGroup": true + } + ``` + parameters: + - in: path + name: sourceId + required: true + x-sailpoint-resource-operation-id: listSources + schema: + type: string + description: The Source id. + example: 2c9180835d191a86015d28455b4a2329 + - in: path + name: schemaId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getSourceSchemas + description: The Schema id. + example: 2c9180835d191a86015d28455b4a2329 + requestBody: + required: true + description: The JSONPatch payload used to update the schema. + content: + application/json-patch+json: + schema: + type: array + items: + $ref: '../schemas/JsonPatchOperation.yaml' + examples: + add-attribute: + summary: Add an attribute to the end of the list + value: [ + { + "op": "add", + "path": "/attributes/-", + "value": { + "name": "location", + "type": "STRING", + "schema": null, + "description": "Employee location", + "isMulti": false, + "isEntitlement": false, + "isGroup": false + } + } + ] + responses: + '200': + description: The Schema was successfully updated. + content: + application/json: + schema: + $ref: '../schemas/Schema.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +delete: + operationId: deleteSourceSchema + tags: + - Sources + summary: Delete Source Schema by ID + parameters: + - in: path + name: sourceId + required: true + x-sailpoint-resource-operation-id: listSources + schema: + type: string + description: The Source id. + example: 2c9180835d191a86015d28455b4a2329 + - in: path + name: schemaId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getSourceSchemas + description: The Schema id. + example: 2c9180835d191a86015d28455b4a2329 + responses: + '204': + $ref: '../responses/204.yaml' + description: The Schema was successfully deleted. + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/schemas.yaml b/static/api-specs/idn/v2025/paths/schemas.yaml new file mode 100644 index 000000000..0c9c61abd --- /dev/null +++ b/static/api-specs/idn/v2025/paths/schemas.yaml @@ -0,0 +1,110 @@ + +get: + operationId: getSourceSchemas + security: + - userAuth: [ idn:source-schema:read ] + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN + tags: + - Sources + summary: List Schemas on Source + description: Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). + parameters: + - in: path + name: sourceId + required: true + x-sailpoint-resource-operation-id: listSources + schema: + type: string + description: Source ID. + example: 2c9180835d191a86015d28455b4a2329 + - in: query + name: include-types + required: false + schema: + type: string + enum: + - group + - user + description: >- + If set to 'group', then the account schema is filtered and only group schemas are returned. Only a + value of 'group' is recognized presently. + + Note: The API will check whether include-types is group or not, + if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. + example: group + - in: query + name: include-names + required: false + schema: + type: string + description: >- + A comma-separated list of schema names to filter result. + example: account + responses: + '200': + description: The schemas were successfully retrieved. + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/Schema.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +post: + operationId: createSourceSchema + security: + - userAuth: [ idn:source-schema:create ] + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + tags: + - Sources + summary: Create Schema on Source + description: | + Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). + parameters: + - in: path + name: sourceId + required: true + x-sailpoint-resource-operation-id: listSources + schema: + type: string + description: Source ID. + example: 2c9180835d191a86015d28455b4a2329 + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/Schema.yaml' + responses: + '201': + description: The schema was successfully created on the specified source. + content: + application/json: + schema: + $ref: '../schemas/Schema.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/search-aggregate.yaml b/static/api-specs/idn/v2025/paths/search-aggregate.yaml new file mode 100644 index 000000000..ca7009416 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/search-aggregate.yaml @@ -0,0 +1,69 @@ +post: + tags: + - Search + description: >- + Performs a search query aggregation and returns the aggregation result. + By default, you can page a maximum of 10,000 search result records. + To page past 10,000 records, you can use searchAfter paging. + Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. + operationId: searchAggregate + security: + - userAuth: [ sp:search:read ] + summary: "Perform a Search Query Aggregation" + parameters: + - $ref: '../parameters/offset.yaml' + - $ref: '../parameters/limit.yaml' + - $ref: '../parameters/count.yaml' + requestBody: + content: + application/json: + schema: + $ref: '../schemas/search/Search.yaml' + examples: + metricAggregation: + $ref: '../schemas/search/aggregate/examples/metricAggregation.yaml' + metricAggregation-dsl: + $ref: '../schemas/search/aggregate/examples/metricAggregation-dsl.yaml' + bucketAggregation: + $ref: '../schemas/search/aggregate/examples/bucketAggregation.yaml' + bucketAggregation-dsl: + $ref: '../schemas/search/aggregate/examples/bucketAggregation-dsl.yaml' + nestedAggregation-bucketAggregation: + $ref: '../schemas/search/aggregate/examples/nestedAggregation-bucketAggregation.yaml' + nestedAggregation-bucketAggregation-dsl: + $ref: '../schemas/search/aggregate/examples/nestedAggregation-bucketAggregation-dsl.yaml' + nestedAggregation-filterAggregation-bucketAggregation: + $ref: '../schemas/search/aggregate/examples/nestedAggregation-filterAggregation-bucketAggregation.yaml' + nestedAggregation-filterAggregation-bucketAggregation-dsl: + $ref: '../schemas/search/aggregate/examples/nestedAggregation-filterAggregation-bucketAggregation-dsl.yaml' + bucketAggregation-subAggregation: + $ref: '../schemas/search/aggregate/examples/bucketAggregation-subAggregation.yaml' + bucketAggregation-subAggregation-dsl: + $ref: '../schemas/search/aggregate/examples/bucketAggregation-subAggregation-dsl.yaml' + required: true + responses: + '200': + description: Aggregation results. + content: + application/json: + schema: + $ref: '../schemas/search/documents/AggregationResult.yaml' + text/csv: + schema: + $ref: '../schemas/search/documents/AggregationResult-csv.yaml' + headers: + X-Total-Count: + description: The total result count (returned only if the *count* parameter is specified as *true*). + schema: + type: integer + example: 5 + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/search-count.yaml b/static/api-specs/idn/v2025/paths/search-count.yaml new file mode 100644 index 000000000..e287d2074 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/search-count.yaml @@ -0,0 +1,37 @@ +post: + tags: + - Search + description: >- + Performs a search with a provided query and returns the count of results in the X-Total-Count header. + operationId: searchCount + security: + - userAuth: [ sp:search:read ] + summary: "Count Documents Satisfying a Query" + requestBody: + content: + application/json: + schema: + $ref: '../schemas/search/Search.yaml' + examples: + query-timeZone: + $ref: '../schemas/search/examples/query-timeZone.yaml' + required: true + responses: + '204': + description: No content - indicates the request was successful but there is no content to be returned in the response. + headers: + X-Total-Count: + description: The total result count. + schema: + type: integer + example: 5 + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/search-get.yaml b/static/api-specs/idn/v2025/paths/search-get.yaml new file mode 100644 index 000000000..0f0273b41 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/search-get.yaml @@ -0,0 +1,54 @@ +get: + tags: + - Search + description: >- + Fetches a single document from the specified index, using the specified document ID. + operationId: searchGet + security: + - userAuth: [ sp:search:read ] + - applicationAuth: [ sp:search:read ] + x-sailpoint-userLevels: + - ORG_ADMIN + - CERT_ADMIN + - REPORT_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN + - ROLE_ADMIN + - ROLE_SUBADMIN + - HELPDESK + summary: "Get a Document by ID" + parameters: + - $ref: '../parameters/path/search/index.yaml' + - $ref: '../parameters/path/search/id.yaml' + responses: + '200': + description: The requested document. + content: + application/json: + schema: + $ref: '../schemas/search/documents/SearchDocument.yaml' + examples: + accessProfile: + $ref: '../schemas/search/documents/examples/accessProfile.yaml' + accountActivity: + $ref: '../schemas/search/documents/examples/accountActivity.yaml' + entitlement: + $ref: '../schemas/search/documents/examples/entitlement.yaml' + event: + $ref: '../schemas/search/documents/examples/event.yaml' + identity: + $ref: '../schemas/search/documents/examples/identity.yaml' + role: + $ref: '../schemas/search/documents/examples/role.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/search-post.yaml b/static/api-specs/idn/v2025/paths/search-post.yaml new file mode 100644 index 000000000..26be00687 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/search-post.yaml @@ -0,0 +1,117 @@ +post: + tags: + - Search + description: >- + Perform a search with the provided query and return a matching result collection. + To page past 10,000 records, you can use `searchAfter` paging. + Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. + externalDocs: + description: Learn more about search. + url: https://documentation.sailpoint.com/saas/help/search/index.html + operationId: searchPost + security: + - userAuth: [ sp:search:read ] + - applicationAuth: [ sp:search:read ] + x-sailpoint-userLevels: + - ORG_ADMIN + - CERT_ADMIN + - REPORT_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN + - ROLE_ADMIN + - ROLE_SUBADMIN + - HELPDESK + summary: "Perform Search" + parameters: + - $ref: '../parameters/offset.yaml' + - $ref: '../parameters/searchlimit.yaml' + - $ref: '../parameters/count.yaml' + requestBody: + content: + application/json: + schema: + $ref: '../schemas/search/Search.yaml' + examples: + accessProfiles: + $ref: '../schemas/search/examples/query-accessprofiles.yaml' + accountActivities: + $ref: '../schemas/search/examples/query-accountactivities.yaml' + entitlements: + $ref: '../schemas/search/examples/query-entitlements.yaml' + events: + $ref: '../schemas/search/examples/query-events.yaml' + identities: + $ref: '../schemas/search/examples/query-identities.yaml' + roles: + $ref: '../schemas/search/examples/query-roles.yaml' + query-fields: + $ref: '../schemas/search/examples/query-fields.yaml' + query-timeZone: + $ref: '../schemas/search/examples/query-timeZone.yaml' + query-innerHit: + $ref: '../schemas/search/examples/query-innerHit.yaml' + typeAheadQuery: + $ref: '../schemas/search/examples/typeAheadQuery.yaml' + typeAheadQuery-nestedType: + $ref: '../schemas/search/examples/typeAheadQuery-nestedType.yaml' + filter-exists: + $ref: '../schemas/search/examples/filter-exists.yaml' + filter-range: + $ref: '../schemas/search/examples/filter-range.yaml' + filter-terms: + $ref: '../schemas/search/examples/filter-terms.yaml' + required: true + responses: + '200': + description: List of matching documents. + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/search/documents/SearchDocuments.yaml' + examples: + accessProfiles: + $ref: '../schemas/search/documents/examples/accessProfiles.yaml' + accountActivities: + $ref: '../schemas/search/documents/examples/accountActivities.yaml' + entitlements: + $ref: '../schemas/search/documents/examples/entitlements.yaml' + events: + $ref: '../schemas/search/documents/examples/events.yaml' + identities: + $ref: '../schemas/search/documents/examples/identities.yaml' + roles: + $ref: '../schemas/search/documents/examples/roles.yaml' + query-fields: + $ref: '../schemas/search/documents/examples/queryFields.yaml' + query-timeZone: + $ref: '../schemas/search/documents/examples/queryTimeZone.yaml' + query-innerHit: + $ref: '../schemas/search/documents/examples/queryInnerHit.yaml' + typeAheadQuery: + $ref: '../schemas/search/documents/examples/typeAheadQuery.yaml' + typeAheadQuery-nestedType: + $ref: '../schemas/search/documents/examples/typeAheadQueryNestedType.yaml' + filter-exists: + $ref: '../schemas/search/documents/examples/filterExists.yaml' + filter-range: + $ref: '../schemas/search/documents/examples/filterRange.yaml' + filter-terms: + $ref: '../schemas/search/documents/examples/filterTerms.yaml' + headers: + X-Total-Count: + schema: + type: integer + description: The total result count (returned only if the *count* parameter is specified as *true*). + example: 30 + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/searchAttributeConfig-get-patch-delete.yaml b/static/api-specs/idn/v2025/paths/searchAttributeConfig-get-patch-delete.yaml new file mode 100644 index 000000000..1b056456f --- /dev/null +++ b/static/api-specs/idn/v2025/paths/searchAttributeConfig-get-patch-delete.yaml @@ -0,0 +1,157 @@ +get: + operationId: getSingleSearchAttributeConfig + tags: + - Search Attribute Configuration + summary: Get Extended Search Attribute + security: + - userAuth: [] + x-sailpoint-userLevels: + - ORG_ADMIN + description: >- + Get an extended attribute configuration by name. + parameters: + - name: name + in: path + description: Name of the extended search attribute configuration to get. + required: true + schema: + type: string + example: newMailAttribute + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Specific attribute configuration in IdentityNow. + content: + application/json: + schema: + $ref: ../schemas/SearchAttributeConfig.yaml + '204': + $ref: ../responses/204.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml +delete: + operationId: deleteSearchAttributeConfig + tags: + - Search Attribute Configuration + summary: Delete Extended Search Attribute + security: + - userAuth: [] + x-sailpoint-userLevels: + - ORG_ADMIN + description: >- + Delete an extended attribute configuration by name. + parameters: + - name: name + in: path + description: Name of the extended search attribute configuration to delete. + required: true + schema: + type: string + example: newMailAttribute + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '204': + $ref: ../responses/204.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml +patch: + operationId: patchSearchAttributeConfig + tags: + - Search Attribute Configuration + summary: Update Extended Search Attribute + security: + - userAuth: [] + x-sailpoint-userLevels: + - ORG_ADMIN + description: >- + Update an existing search attribute configuration. + + You can patch these fields: + + * name + * displayName + * applicationAttributes + parameters: + - name: name + in: path + description: Name of the search attribute configuration to patch. + required: true + schema: + type: string + example: promotedMailAttribute + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: ../schemas/JsonPatchOperation.yaml + example: + - op: replace + path: /name + value: newAttributeName + - op: replace + path: /displayName + value: new attribute display name + - op: add + path: /applicationAttributes + value: + 2c91808b79fd2422017a0b35d30f3968: employeeNumber + required: true + responses: + '200': + description: Responds with the search attribute configuration as updated. + content: + application/json: + schema: + $ref: ../schemas/SearchAttributeConfig.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/searchAttributeConfig.yaml b/static/api-specs/idn/v2025/paths/searchAttributeConfig.yaml new file mode 100644 index 000000000..c7f760f70 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/searchAttributeConfig.yaml @@ -0,0 +1,94 @@ +post: + operationId: createSearchAttributeConfig + tags: + - Search Attribute Configuration + summary: Create Extended Search Attributes + security: + - userAuth: [ idn:account-config:create ] + x-sailpoint-userLevels: + - ORG_ADMIN + description: >- + Create and configure extended search attributes. + This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. + It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. + + >**Note: Give searchable attributes unique names. + Do not give them the same names used for account attributes or source attributes. + Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes' `applicationAttributes`.** + requestBody: + required: true + content: + application/json: + schema: + $ref: ../schemas/SearchAttributeConfig.yaml + example: + name: newMailAttribute + displayName: New Mail Attribute + applicationAttributes: + 2c9180866166b5b0016167c32ef31a66: mail + 2c9180866166b5b0016167c32ef31a67: mail + responses: + '202': + $ref: ../responses/202.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true +get: + operationId: getSearchAttributeConfig + tags: + - Search Attribute Configuration + summary: List Extended Search Attributes + security: + - userAuth: [ idn:account-config:read ] + x-sailpoint-userLevels: + - ORG_ADMIN + description: >- + Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). + parameters: + - $ref: '../parameters/limit.yaml' + - $ref: '../parameters/offset.yaml' + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: List of attribute configurations in ISC. + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/SearchAttributeConfig.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/segment-change-assignments.yaml b/static/api-specs/idn/v2025/paths/segment-change-assignments.yaml new file mode 100644 index 000000000..6bdbb2b0a --- /dev/null +++ b/static/api-specs/idn/v2025/paths/segment-change-assignments.yaml @@ -0,0 +1,81 @@ +post: + operationId: segmentChangeAssignments + tags: + - Segments + summary: Change Segment assignments. + description: >- + This API makes changes to the objects which are assigned to a Segment. + + + No more than 50 changes can be made in a single call. A 400 error will result if more changes than that are + specified. + + + Note that segmentation changes may take time to propagate through the system. + + + + A token with ORG_ADMIN or API authority is required to call this API. + parameters: + - in: path + name: id + required: true + x-sailpoint-resource-operation-id: listSegments + schema: + type: string + description: The ID of the Segment + example: ab5fc0cd-e021-4b76-96e6-4818df0d73d5 + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/SegmentChangeAssignments.yaml' + responses: + '202': + description: Accepted for processing, indicates no errors detected. + $ref: '../responses/202.yaml' + '400': + description: Client Error - Returned if the request body is invalid. + content: + application/json: + schema: + $ref: '../schemas/ErrorResponseDto.yaml' + examples: + 400.1 Bad Request Content: + description: Response for bad request content + value: + detailCode: 400.1 Bad Request Content + trackingId: 1ea1adcb84da4dcb890145e05745774e + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The request was syntactically correct but its content is semantically invalid. + 400.1.4 Entitlements limit violation: + description: Entitlements limit violation response + value: + detailCode: 400.1.4 Limit violation + trackingId: 77aa89ac6f0e422dbc588866abc22be9 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: You have reached the current limit of 20000 entitlements. + 400.1.4 Segments limit violation: + description: Segments limit violation response + value: + detailCode: 400.1.4 Limit violation + trackingId: 77aa89ac6f0e422dbc588866abc22be9 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: You have reached the current limit of 100 segments for entitlement. + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + + diff --git a/static/api-specs/idn/v2025/paths/segment.yaml b/static/api-specs/idn/v2025/paths/segment.yaml new file mode 100644 index 000000000..309de71d6 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/segment.yaml @@ -0,0 +1,159 @@ +get: + operationId: getSegment + security: + - userAuth: [ idn:segment:read, idn:segment:manage ] + - applicationAuth: [ idn:segment:read, idn:segment:manage ] + x-sailpoint-userLevels: + - ORG_ADMIN + tags: + - Segments + summary: Get Segment by ID + description: >- + This API returns the segment specified by the given ID. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSegments + description: The segment ID to retrieve. + example: ef38f94347e94562b5bb8424a56397d8 + responses: + '200': + description: Segment + content: + application/json: + schema: + $ref: '../schemas/Segment.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +delete: + operationId: deleteSegment + security: + - userAuth: [ idn:segment:manage ] + - applicationAuth: [ idn:segment:manage ] + x-sailpoint-userLevels: + - ORG_ADMIN + tags: + - Segments + summary: Delete Segment by ID + description: >- + This API deletes the segment specified by the given ID. + + >**Note:** that segment deletion may take some time to become effective. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSegments + description: The segment ID to delete. + example: ef38f94347e94562b5bb8424a56397d8 + responses: + '204': + description: No content. + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +patch: + operationId: patchSegment + security: + - userAuth: [ idn:segment:manage ] + - applicationAuth: [ idn:segment:manage ] + x-sailpoint-userLevels: + - ORG_ADMIN + tags: + - Segments + summary: Update Segment + description: >- + Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + >**Note:** Changes to a segment may take some time to propagate to all identities. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSegments + description: The segment ID to modify. + example: ef38f94347e94562b5bb8424a56397d8 + requestBody: + required: true + description: | + A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + The following fields are patchable: + * name + * description + * owner + * visibilityCriteria + * active + content: + application/json-patch+json: + schema: + type: array + items: + type: object + examples: + Set Visibility Criteria: + description: Set the visibility criteria + value: + - op: "replace" + path: "/visibilityCriteria" + value: + expression: + operator: "AND" + children: + - operator: "EQUALS" + attribute: "location" + value: + type: "STRING" + value: "Philadelphia" + - operator: "EQUALS" + attribute: "department" + value: + type: "STRING" + value: "HR" + + responses: + '200': + description: >- + Indicates the PATCH operation succeeded, and returns the segment's new representation. + content: + application/json: + schema: + $ref: '../schemas/Segment.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/segments.yaml b/static/api-specs/idn/v2025/paths/segments.yaml new file mode 100644 index 000000000..48b81b5c2 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/segments.yaml @@ -0,0 +1,72 @@ +post: + operationId: createSegment + security: + - userAuth: [ idn:segment:manage ] + - applicationAuth: [ idn:segment:manage ] + x-sailpoint-userLevels: + - ORG_ADMIN + tags: + - Segments + summary: Create Segment + description: >- + This API creates a segment. + + >**Note:** Segment definitions may take time to propagate to all identities. + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/Segment.yaml' + responses: + '201': + description: Segment created + content: + application/json: + schema: + $ref: '../schemas/Segment.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +get: + operationId: listSegments + security: + - userAuth: [ idn:segment:read, idn:segment:manage ] + - applicationAuth: [ idn:segment:read, idn:segment:manage ] + x-sailpoint-userLevels: + - ORG_ADMIN + tags: + - Segments + summary: List Segments + description: >- + This API returns a list of all segments. + parameters: + - $ref: '../parameters/limit.yaml' + - $ref: '../parameters/offset.yaml' + - $ref: '../parameters/count.yaml' + responses: + '200': + description: List of all segments + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/Segment.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/send-test-notification.yaml b/static/api-specs/idn/v2025/paths/send-test-notification.yaml new file mode 100644 index 000000000..07a65da13 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/send-test-notification.yaml @@ -0,0 +1,42 @@ +post: + operationId: sendTestNotification + tags: + - Notifications + summary: Send Test Notification + description: Send a Test Notification + requestBody: + required: true + content: + application/json: + schema: + $ref: ../schemas/SendTestNotificationRequestDto.yaml + example: + key: cloud_manual_work_item_summary + medium: EMAIL + context: + numberOfPendingTasks: '4' + ownerId: 201327fda1c44704ac01181e963d463c + responses: + '204': + $ref: ../responses/204.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true diff --git a/static/api-specs/idn/v2025/paths/service-desk-integration-configuration.yaml b/static/api-specs/idn/v2025/paths/service-desk-integration-configuration.yaml new file mode 100644 index 000000000..d22e34f05 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/service-desk-integration-configuration.yaml @@ -0,0 +1,65 @@ +get: + tags: + - Service Desk Integration + summary: Get the time check configuration + description: Get the time check configuration of queued SDIM tickets. + operationId: getStatusCheckDetails + responses: + "200": + description: QueuedCheckConfigDetails containing the configured values + content: + application/json: + schema: + $ref: '../schemas/QueuedCheckConfigDetails.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + security: + - userAuth: [idn:service-desk-integration:read, idn:service-desk-integration:manage] + x-sailpoint-userLevels: + - ORG_ADMIN +put: + tags: + - Service Desk Integration + summary: Update the time check configuration + description: Update the time check configuration of queued SDIM tickets. + operationId: updateStatusCheckDetails + requestBody: + description: The modified time check configuration + content: + application/json: + schema: + $ref: '../schemas/QueuedCheckConfigDetails.yaml' + required: true + responses: + "200": + description: QueuedCheckConfigDetails as updated + content: + application/json: + schema: + $ref: '../schemas/QueuedCheckConfigDetails.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + security: + - userAuth: [idn:service-desk-integration:manage] + x-sailpoint-userLevels: + - ORG_ADMIN \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/service-desk-integration-template.yaml b/static/api-specs/idn/v2025/paths/service-desk-integration-template.yaml new file mode 100644 index 000000000..a9bf62e94 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/service-desk-integration-template.yaml @@ -0,0 +1,40 @@ +get: + tags: + - Service Desk Integration + summary: Service Desk integration template by scriptName + description: This API endpoint returns an existing Service Desk integration template by scriptName. + operationId: getServiceDeskIntegrationTemplate + parameters: + - name: scriptName + in: path + description: The scriptName value of the Service Desk integration template to get + required: true + x-sailpoint-resource-operation-id: getServiceDeskIntegrations + style: simple + explode: false + schema: + type: string + example: aScriptName + responses: + "200": + description: Responds with the ServiceDeskIntegrationTemplateDto with the specified scriptName. + content: + application/json: + schema: + $ref: '../schemas/ServiceDeskIntegrationTemplateDto.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + security: + - userAuth: [idn:service-desk-integration:read, idn:service-desk-integration:manage] + x-sailpoint-userLevels: + - ORG_ADMIN \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/service-desk-integration-types.yaml b/static/api-specs/idn/v2025/paths/service-desk-integration-types.yaml new file mode 100644 index 000000000..87395888d --- /dev/null +++ b/static/api-specs/idn/v2025/paths/service-desk-integration-types.yaml @@ -0,0 +1,31 @@ +get: + tags: + - Service Desk Integration + summary: List Service Desk integration types + description: This API endpoint returns the current list of supported Service Desk integration types. + operationId: getServiceDeskIntegrationTypes + responses: + "200": + description: Responds with an array of the currently supported Service Desk integration types. + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/ServiceDeskIntegrationTemplateType.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + security: + - userAuth: [idn:service-desk-integration:read, idn:service-desk-integration:manage] + x-sailpoint-userLevels: + - ORG_ADMIN \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/service-desk-integration.yaml b/static/api-specs/idn/v2025/paths/service-desk-integration.yaml new file mode 100644 index 000000000..abcdfab55 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/service-desk-integration.yaml @@ -0,0 +1,197 @@ +get: + tags: + - Service Desk Integration + summary: Get a Service Desk integration + description: Get an existing Service Desk integration by ID. + operationId: getServiceDeskIntegration + parameters: + - name: id + in: path + description: ID of the Service Desk integration to get + required: true + x-sailpoint-resource-operation-id: getServiceDeskIntegrations + style: simple + explode: false + schema: + type: string + example: anId + responses: + "200": + description: ServiceDeskIntegrationDto with the given ID + content: + application/json: + schema: + $ref: '../schemas/ServiceDeskIntegrationDto.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + security: + - userAuth: [idn:service-desk-integration:read, idn:service-desk-integration:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + +put: + tags: + - Service Desk Integration + summary: Update a Service Desk integration + description: Update an existing Service Desk integration by ID. + operationId: putServiceDeskIntegration + parameters: + - name: id + in: path + description: ID of the Service Desk integration to update + required: true + x-sailpoint-resource-operation-id: getServiceDeskIntegrations + style: simple + explode: false + schema: + type: string + example: anId + requestBody: + description: The specifics of the integration to update + content: + application/json: + schema: + $ref: '../schemas/ServiceDeskIntegrationDto.yaml' + required: true + responses: + "200": + description: ServiceDeskIntegrationDto as updated + content: + application/json: + schema: + $ref: '../schemas/ServiceDeskIntegrationDto.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + security: + - userAuth: [idn:service-desk-integration:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + +delete: + tags: + - Service Desk Integration + summary: Delete a Service Desk integration + description: Delete an existing Service Desk integration by ID. + operationId: deleteServiceDeskIntegration + parameters: + - name: id + in: path + description: ID of Service Desk integration to delete + required: true + x-sailpoint-resource-operation-id: getServiceDeskIntegrations + style: simple + explode: false + schema: + type: string + example: anId + responses: + "204": + description: Service Desk integration with the given ID successfully deleted + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + security: + - userAuth: [idn:service-desk-integration:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + +patch: + operationId: patchServiceDeskIntegration + tags: + - Service Desk Integration + summary: Patch a Service Desk Integration + description: Update an existing Service Desk integration by ID with a PATCH request. + parameters: + - name: id + in: path + description: ID of the Service Desk integration to update + required: true + x-sailpoint-resource-operation-id: getServiceDeskIntegrations + style: simple + explode: false + schema: + type: string + example: anId + requestBody: + required: true + description: | + A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + Only `replace` operations are accepted by this endpoint. + + A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + content: + application/json-patch+json: + schema: + type: object + description: A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902). Only `replace` operations are accepted by this endpoint. + properties: + operations: + description: Operations to be applied + type: array + items: + $ref: '../schemas/JsonPatchOperation.yaml' + example: + [ + { + "op": "replace", + "path": "/ownerRef", + "value": { + "id": "2c9180867d05b227017d09921a205b4d", + "type": "IDENTITY", + "name": "Angelo Medici" + } + } + ] + responses: + "200": + description: ServiceDeskIntegrationDto as updated + content: + application/json: + schema: + $ref: '../schemas/ServiceDeskIntegrationDto.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + security: + - userAuth: [idn:service-desk-integration:manage] + x-sailpoint-userLevels: + - ORG_ADMIN \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/service-desk-integrations.yaml b/static/api-specs/idn/v2025/paths/service-desk-integrations.yaml new file mode 100644 index 000000000..1ae10b957 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/service-desk-integrations.yaml @@ -0,0 +1,111 @@ +get: + tags: + - Service Desk Integration + summary: List existing Service Desk integrations + description: Get a list of Service Desk integration objects. + operationId: getServiceDeskIntegrations + parameters: + - $ref: '../parameters/offset.yaml' + - $ref: '../parameters/limit.yaml' + - name: sorters + in: query + required: false + style: form + explode: true + schema: + type: string + description: >- + Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **name** + example: name + - name: filters + in: query + required: false + style: form + explode: true + schema: + type: string + format: comma-separated + description: >- + Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) + + + Filtering is supported for the following fields and operators: + + + **id**: *eq, in* + + + **name**: *eq* + + + **type**: *eq, in* + + + **cluster**: *eq, in* + example: name eq "John Doe" + - $ref: '../parameters/count.yaml' + responses: + "200": + description: List of ServiceDeskIntegrationDto + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/ServiceDeskIntegrationDto.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + security: + - userAuth: [idn:service-desk-integration:read, idn:service-desk-integration:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + +post: + tags: + - Service Desk Integration + summary: Create new Service Desk integration + description: Create a new Service Desk integration. + operationId: createServiceDeskIntegration + requestBody: + description: The specifics of a new integration to create + content: + application/json: + schema: + $ref: '../schemas/ServiceDeskIntegrationDto.yaml' + required: true + responses: + "200": + description: Details of the created integration + content: + application/json: + schema: + $ref: '../schemas/ServiceDeskIntegrationDto.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + security: + - userAuth: [idn:service-desk-integration:manage] + x-sailpoint-userLevels: + - ORG_ADMIN \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/set-password.yaml b/static/api-specs/idn/v2025/paths/set-password.yaml new file mode 100644 index 000000000..e64284099 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/set-password.yaml @@ -0,0 +1,50 @@ +post: + operationId: setPassword + tags: + - Password Management + summary: Set Identity's Password + security: + - applicationAuth: [] + description: | + This API is used to set a password for an identity. + + An identity can change their own password (as well as any of their accounts' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or ["authorization_code" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). + + >**Note: If you want to set an identity's source account password, you must enable `PASSWORD` as one of the source's features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** + + To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: + + ```bash + echo -n "myPassword" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 + ``` + + In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. + + To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. + + If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. + + You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/PasswordChangeRequest.yaml' + responses: + '202': + description: Reference to the password change. + content: + application/json: + schema: + $ref: '../schemas/PasswordChangeResponse.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/sim-integrations-before-provisioning-rule.yaml b/static/api-specs/idn/v2025/paths/sim-integrations-before-provisioning-rule.yaml new file mode 100644 index 000000000..16930a400 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/sim-integrations-before-provisioning-rule.yaml @@ -0,0 +1,54 @@ +patch: + tags: + - SIM Integrations + summary: Patch a SIM beforeProvisioningRule attribute. + description: Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. + operationId: patchBeforeProvisioningRule + requestBody: + required: true + description: The JsonPatch object that describes the changes of SIM beforeProvisioningRule. + content: + application/json-patch+json: + schema: + $ref: ../schemas/JsonPatch.yaml + parameters: + - name: id + in: path + description: SIM integration id + schema: + type: string + example: 12345 + required: true + x-sailpoint-resource-operation-id: getSIMIntegrations + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: The updated DTO containing the details of the SIM integration. + content: + application/json: + schema: + $ref: ../schemas/ServiceDeskIntegrationDto.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: + - idn:service-desk-admin:write + x-sailpoint-userLevels: + - ORG_ADMIN diff --git a/static/api-specs/idn/v2025/paths/sim-integrations-value-list.yaml b/static/api-specs/idn/v2025/paths/sim-integrations-value-list.yaml new file mode 100644 index 000000000..e77550375 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/sim-integrations-value-list.yaml @@ -0,0 +1,87 @@ +get: + tags: + - SIM Integrations + summary: List the existing SIM integrations. + description: List the existing SIM integrations. + operationId: getSIMIntegrations + responses: + '200': + description: The DTO containing the details of the SIM integration + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/ServiceDeskIntegrationDto.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: + - idn:service-desk-admin:read + x-sailpoint-userLevels: + - ORG_ADMIN + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true +post: + tags: + - SIM Integrations + summary: Create new SIM integration + description: Create a new SIM Integrations. + operationId: createSIMIntegration + requestBody: + description: DTO containing the details of the SIM integration + content: + application/json: + schema: + $ref: ../schemas/SimIntegrationDetails.yaml + required: true + responses: + '200': + description: details of the created integration + content: + application/json: + schema: + $ref: ../schemas/ServiceDeskIntegrationDto.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: + - idn:service-desk-admin:create + x-sailpoint-userLevels: + - ORG_ADMIN + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true diff --git a/static/api-specs/idn/v2025/paths/sim-integrations.yaml b/static/api-specs/idn/v2025/paths/sim-integrations.yaml new file mode 100644 index 000000000..e7e1b216f --- /dev/null +++ b/static/api-specs/idn/v2025/paths/sim-integrations.yaml @@ -0,0 +1,198 @@ +put: + tags: + - SIM Integrations + summary: Update an existing SIM integration + description: Update an existing SIM integration. + operationId: putSIMIntegration + requestBody: + description: The full DTO of the integration containing the updated model + content: + application/json: + schema: + $ref: ../schemas/SimIntegrationDetails.yaml + required: true + parameters: + - name: id + in: path + description: The id of the integration. + schema: + type: string + example: 12345 + required: true + x-sailpoint-resource-operation-id: getSIMIntegrations + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: details of the updated integration + content: + application/json: + schema: + $ref: ../schemas/ServiceDeskIntegrationDto.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: + - idn:service-desk-admin:create + x-sailpoint-userLevels: + - ORG_ADMIN +get: + tags: + - SIM Integrations + summary: Get a SIM integration details. + description: Get the details of a SIM integration. + operationId: getSIMIntegration + parameters: + - name: id + in: path + description: The id of the integration. + schema: + type: string + example: 12345 + required: true + x-sailpoint-resource-operation-id: getSIMIntegrations + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: The DTO containing the details of the SIM integration + content: + application/json: + schema: + $ref: ../schemas/ServiceDeskIntegrationDto.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: + - idn:service-desk-admin:read + x-sailpoint-userLevels: + - ORG_ADMIN +delete: + tags: + - SIM Integrations + summary: Delete a SIM integration + description: Get the details of a SIM integration. + operationId: deleteSIMIntegration + parameters: + - name: id + description: The id of the integration to delete. + in: path + schema: + type: string + example: 12345 + required: true + x-sailpoint-resource-operation-id: getSIMIntegrations + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: No content response + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: + - idn:service-desk-admin:write + x-sailpoint-userLevels: + - ORG_ADMIN +patch: + tags: + - SIM Integrations + summary: Patch a SIM attribute. + description: Patch a SIM attribute given a JsonPatch object. + operationId: patchSIMAttributes + requestBody: + required: true + description: The JsonPatch object that describes the changes of SIM + content: + application/json-patch+json: + schema: + $ref: ../schemas/JsonPatch.yaml + parameters: + - name: id + description: SIM integration id + in: path + schema: + type: string + example: 12345 + required: true + x-sailpoint-resource-operation-id: getSIMIntegrations + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: The updated DTO containing the details of the SIM integration. + content: + application/json: + schema: + $ref: ../schemas/ServiceDeskIntegrationDto.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: + - idn:service-desk-admin:write + x-sailpoint-userLevels: + - ORG_ADMIN diff --git a/static/api-specs/idn/v2025/paths/sod-all-report-run.yaml b/static/api-specs/idn/v2025/paths/sod-all-report-run.yaml new file mode 100644 index 000000000..262ccc466 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/sod-all-report-run.yaml @@ -0,0 +1,45 @@ +post: + security: + - userAuth: [idn:sod-violation:write] + operationId: startSodAllPoliciesForOrg + tags: + - SOD Policies + summary: Runs all policies for org + description: >- + Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. + If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. + requestBody: + required: false + content: + application/json: + schema: + $ref: '../schemas/MultiPolicyRequest.yaml' + example: { + "filteredPolicyList": [ + "b868cd40-ffa4-4337-9c07-1a51846cfa94", + "63a07a7b-39a4-48aa-956d-50c827deba2a" + ] + } + responses: + '200': + description: Reference to the violation report run task. + content: + application/json: + schema: + $ref: '../schemas/ReportResultReference.yaml' + example: { + "status": "PENDING", + "type": "REPORT_RESULT", + "id": "37b3b32a-f394-46f8-acad-b5223969fa68", + "name": "Multi Query Report" + } + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/sod-all-report-status.yaml b/static/api-specs/idn/v2025/paths/sod-all-report-status.yaml new file mode 100644 index 000000000..e586fb382 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/sod-all-report-status.yaml @@ -0,0 +1,32 @@ +get: + security: + - userAuth: [idn:sod-violation:read] + operationId: getSodAllReportRunStatus + tags: + - SOD Policies + summary: Get multi-report run task status + description: >- + This endpoint gets the status for a violation report for all policy run. + responses: + '200': + description: Status of the violation report run task for all policy run. + content: + application/json: + schema: + $ref: '../schemas/ReportResultReference.yaml' + example: { + "status": "SUCCESS", + "type": "REPORT_RESULT", + "id": "37b3b32a-f394-46f8-acad-b5223969fa68", + "name": "Multi Query Report" + } + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/sod-download-custom-report.yaml b/static/api-specs/idn/v2025/paths/sod-download-custom-report.yaml new file mode 100644 index 000000000..e3b0401d6 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/sod-download-custom-report.yaml @@ -0,0 +1,45 @@ +get: + security: + - userAuth: [idn:sod-violation:read] + operationId: getCustomViolationReport + tags: + - SOD Policies + summary: Download custom violation report + description: >- + This allows to download a specified named violation report for a given report reference. + parameters: + - in: path + name: reportResultId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: startSodPolicy + description: The ID of the report reference to download. + example: ef38f94347e94562b5bb8424a56397d8 + - in: path + name: fileName + schema: + type: string + required: true + description: Custom Name for the file. + example: custom-name + responses: + '200': + description: Returns the zip file with given custom name that contains the violation report file. + content: + application/zip: + schema: + type: string + format: binary + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/sod-download-default-report.yaml b/static/api-specs/idn/v2025/paths/sod-download-default-report.yaml new file mode 100644 index 000000000..c7b7a7eab --- /dev/null +++ b/static/api-specs/idn/v2025/paths/sod-download-default-report.yaml @@ -0,0 +1,38 @@ +get: + security: + - userAuth: [idn:sod-violation:read] + operationId: getDefaultViolationReport + tags: + - SOD Policies + summary: Download violation report + description: >- + This allows to download a violation report for a given report reference. + parameters: + - in: path + name: reportResultId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: startSodPolicy + description: The ID of the report reference to download. + example: ef38f94347e94562b5bb8424a56397d8 + responses: + '200': + description: Returns the PolicyReport.zip that contains the violation report file. + content: + application/zip: + schema: + type: string + format: binary + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/sod-exception.yaml b/static/api-specs/idn/v2025/paths/sod-exception.yaml new file mode 100644 index 000000000..bf6eddf46 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/sod-exception.yaml @@ -0,0 +1,129 @@ +get: + operationId: getSodExceptionById + tags: + - SOD Exception + summary: Get SOD exception by ID + # security: + # - oauth2: [API] + description: >- + This API returns the specified SOD exception. + + + A token with API authority is required to call this API. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSodExceptions + description: The ID of the object reference to retrieve. + example: ef38f94347e94562b5bb8424a56397d8 + responses: + '200': + $ref: '../schemas/sod/responses/200.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +patch: + operationId: patchExceptionById + tags: + - SOD Exception + summary: Update SOD exception + # security: + # - oauth2: [API] + description: >- + This API allows updating SOD exception fields other than ["id", "created", "origin"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + + A token with API authority is required to call this API. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSodExceptions + description: The ID of the SOD exception to update. + example: ef38f94347e94562b5bb8424a56397d8 + requestBody: + required: true + description: | + A list of SOD policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + The following fields are patchable: + * policyId + * identityId + * start + * end + * businessJustification + * mitigatingControl + content: + application/json-patch+json: + schema: + type: array + items: + type: object + examples: + Update exception: + $ref: '../schemas/sod/examples/exception-body-patch.yaml' + responses: + '200': + $ref: '../schemas/sod/responses/200-patch.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +delete: + operationId: deleteSodExceptionById + tags: + - SOD Exception + summary: Delete SOD exception by ID + # security: + # - oauth2: [API] + description: >- + This API deletes the specified SOD exception. + + + A token with API authority is required to call this API. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSodExceptions + description: The ID of the SOD exception to delete. + example: ef38f94347e94562b5bb8424a56397d8 + responses: + '204': + description: No content. + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/sod-exceptions-bulk-create.yaml b/static/api-specs/idn/v2025/paths/sod-exceptions-bulk-create.yaml new file mode 100644 index 000000000..935d71d30 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/sod-exceptions-bulk-create.yaml @@ -0,0 +1,34 @@ +post: + operationId: bulkCreateSodExceptions + tags: + - SOD Exception + summary: Create SOD exceptions in bulk + # security: + # - oauth2: [API] + description: >- + This API creates SOD exceptions in bulk. + + + A token with API authority is required to call this API. + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/sod/models/ExceptionList.yaml' + examples: + Exception list: + $ref: '../schemas/sod/examples/exception-body-bulk.yaml' + responses: + '202': + $ref: '../schemas/sod/responses/202.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/sod-exceptions.yaml b/static/api-specs/idn/v2025/paths/sod-exceptions.yaml new file mode 100644 index 000000000..279b517f9 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/sod-exceptions.yaml @@ -0,0 +1,91 @@ +post: + operationId: createSodException + tags: + - SOD Exception + summary: Create SOD exception + description: >- + This API creates a SOD exception. + + + A token with API authority is required to call this API. + requestBody: + required: true + content: + application/json: + schema: + $ref: "../schemas/sod/models/Exception.yaml" + examples: + Exception created: + $ref: "../schemas/sod/examples/exception-body.yaml" + responses: + "201": + $ref: "../schemas/sod/responses/201.yaml" + "400": + $ref: "../responses/400.yaml" + "401": + $ref: "../responses/401.yaml" + "403": + $ref: "../responses/403.yaml" + "429": + $ref: "../responses/429.yaml" + "500": + $ref: "../responses/500.yaml" +get: + operationId: listSodExceptions + tags: + - SOD Exception + summary: List SOD exceptions + description: >- + This API returns a list of all SOD exceptions. + + + A token with API authority is required to call this API. + parameters: + - $ref: "../parameters/limit.yaml" + - $ref: "../parameters/offset.yaml" + - $ref: "../parameters/count.yaml" + - in: query + name: filters + schema: + type: string + description: >- + Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) + + + Filtering is supported for the following fields and operators: + + + **id**: *eq, in* + + + **sodPolicy.id**: *eq, in* + + + **identity.id**: *eq, in* + example: identity.id eq "bc693f07e7b645539626c25954c58554" + required: false + - in: query + name: sorters + schema: + type: string + format: comma-separated + description: >- + Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **sodPolicy.id, identity.id, start, end** + example: identity.id,-start + required: false + responses: + "200": + $ref: "../schemas/sod/responses/200-list.yaml" + "400": + $ref: "../responses/400.yaml" + "401": + $ref: "../responses/401.yaml" + "403": + $ref: "../responses/403.yaml" + "429": + $ref: "../responses/429.yaml" + "500": + $ref: "../responses/500.yaml" diff --git a/static/api-specs/idn/v2025/paths/sod-policies.yaml b/static/api-specs/idn/v2025/paths/sod-policies.yaml new file mode 100644 index 000000000..26086467f --- /dev/null +++ b/static/api-specs/idn/v2025/paths/sod-policies.yaml @@ -0,0 +1,399 @@ +post: + security: + - userAuth: [idn:sod-policy:write] + operationId: createSodPolicy + tags: + - SOD Policies + summary: Create SOD policy + description: >- + This creates both General and Conflicting Access Based policy, with a limit + of 50 entitlements for each (left & right) criteria for Conflicting Access + Based SOD policy. + + Requires role of ORG_ADMIN. + requestBody: + required: true + content: + application/json: + schema: + $ref: "../schemas/SodPolicy.yaml" + examples: + Conflicting Access Based Policy: + value: + { + "name": "Conflicting-Policy-Name", + "description": "This policy ensures compliance of xyz", + "ownerRef": + { + "type": "IDENTITY", + "id": "2c91808568c529c60168cca6f90c1313", + "name": "Owner Name", + }, + "externalPolicyReference": "XYZ policy", + "compensatingControls": + 'Have a manager review the transaction decisions for their + "out of compliance" employee', + "correctionAdvice": + "Based on the role of the employee, managers should remove + access that is not required for their job function.", + "state": "ENFORCED", + "tags": ["string"], + "creatorId": "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId": "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "violationOwnerAssignmentConfig": + { + "assignmentRule": "MANAGER", + "ownerRef": + { + "type": "IDENTITY", + "id": "2c91808568c529c60168cca6f90c1313", + "name": "Violation Owner Name", + }, + }, + "scheduled": true, + "type": "CONFLICTING_ACCESS_BASED", + "conflictingAccessCriteria": + { + "leftCriteria": + { + "name": "money-in", + "criteriaList": + [ + { + "type": "ENTITLEMENT", + "id": "2c9180866166b5b0016167c32ef31a66", + }, + { + "type": "ENTITLEMENT", + "id": "2c9180866166b5b0016167c32ef31a67", + }, + ], + }, + "rightCriteria": + { + "name": "money-out", + "criteriaList": + [ + { + "type": "ENTITLEMENT", + "id": "2c9180866166b5b0016167c32ef31a68", + }, + { + "type": "ENTITLEMENT", + "id": "2c9180866166b5b0016167c32ef31a69", + }, + ], + }, + }, + } + General Policy: + value: + { + "description": "Description", + "ownerRef": + { + "type": "IDENTITY", + "id": "2c918087682f9a86016839c05e8f1aff", + "name": "Owner Name", + }, + "externalPolicyReference": "New policy", + "policyQuery": "policy query implementation", + "compensatingControls": "Compensating controls", + "correctionAdvice": "Correction advice", + "tags": [], + "state": "ENFORCED", + "scheduled": false, + "creatorId": "2c918087682f9a86016839c05e8f1aff", + "modifierId": null, + "violationOwnerAssignmentConfig": null, + "name": "General-Policy-Name", + } + responses: + "201": + description: SOD policy created + content: + application/json: + schema: + $ref: "../schemas/SodPolicy.yaml" + examples: + Conflicting Access Based Policy: + value: + { + "id": "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "name": "Conflicting-Policy-Name", + "created": "2020-01-01T00:00:00.000000Z", + "modified": "2020-01-01T00:00:00.000000Z", + "description": "This policy ensures compliance of xyz", + "ownerRef": + { + "type": "IDENTITY", + "id": "2c91808568c529c60168cca6f90c1313", + "name": "Owner Name", + }, + "externalPolicyReference": "XYZ policy", + "policyQuery": + "@access(id:2c9180866166b5b0016167c32ef31a66 OR + id:2c9180866166b5b0016167c32ef31a67) AND + @access(id:2c9180866166b5b0016167c32ef31a68 OR + id:2c9180866166b5b0016167c32ef31a69)", + "compensatingControls": + 'Have a manager review the transaction decisions for their + "out of compliance" employee', + "correctionAdvice": + "Based on the role of the employee, managers should remove + access that is not required for their job function.", + "state": "ENFORCED", + "tags": ["string"], + "creatorId": "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId": "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "violationOwnerAssignmentConfig": + { + "assignmentRule": "MANAGER", + "ownerRef": + { + "type": "IDENTITY", + "id": "2c91808568c529c60168cca6f90c1313", + "name": "Violation Owner Name", + }, + }, + "scheduled": true, + "type": "CONFLICTING_ACCESS_BASED", + "conflictingAccessCriteria": + { + "leftCriteria": + { + "name": "money-in", + "criteriaList": + [ + { + "type": "ENTITLEMENT", + "id": "2c9180866166b5b0016167c32ef31a66", + }, + { + "type": "ENTITLEMENT", + "id": "2c9180866166b5b0016167c32ef31a67", + }, + ], + }, + "rightCriteria": + { + "name": "money-out", + "criteriaList": + [ + { + "type": "ENTITLEMENT", + "id": "2c9180866166b5b0016167c32ef31a68", + }, + { + "type": "ENTITLEMENT", + "id": "2c9180866166b5b0016167c32ef31a69", + }, + ], + }, + }, + } + General Policy: + value: + { + "description": "Description", + "ownerRef": + { + "type": "IDENTITY", + "id": "2c918087682f9a86016839c05e8f1aff", + "name": "Owner Name", + }, + "externalPolicyReference": "New policy", + "policyQuery": "policy query implementation", + "compensatingControls": "Compensating controls", + "correctionAdvice": "Correction advice", + "tags": [], + "state": "ENFORCED", + "scheduled": false, + "creatorId": "2c918087682f9a86016839c05e8f1aff", + "modifierId": null, + "violationOwnerAssignmentConfig": null, + "type": "GENERAL", + "conflictingAccessCriteria": null, + "id": "52c11db4-733e-4c31-949a-766c95ec95f1", + "name": "General-Policy-Name", + "created": "2020-05-12T19:47:38Z", + "modified": "2020-05-12T19:47:38Z", + } + "400": + $ref: "../responses/400.yaml" + "401": + $ref: "../responses/401.yaml" + "403": + $ref: "../responses/403.yaml" + "429": + $ref: "../responses/429.yaml" + "500": + $ref: "../responses/500.yaml" +get: + security: + - userAuth: [idn:sod-policy:read] + operationId: listSodPolicies + tags: + - SOD Policies + summary: List SOD policies + description: >- + This gets list of all SOD policies. + + Requires role of ORG_ADMIN + parameters: + - $ref: "../parameters/limit.yaml" + - $ref: "../parameters/offset.yaml" + - $ref: "../parameters/count.yaml" + - in: query + name: filters + schema: + type: string + description: >- + Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) + + + Filtering is supported for the following fields and operators: + + + **id**: *eq, in* + + + **name**: *eq, in* + + + **state**: *eq, in* + example: id eq "bc693f07e7b645539626c25954c58554" + required: false + - in: query + name: sorters + required: false + schema: + type: string + format: comma-separated + example: id,name + description: >- + Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **id, name, created, modified, description** + responses: + "200": + description: List of all SOD policies. + content: + application/json: + schema: + type: array + items: + $ref: "../schemas/SodPolicy.yaml" + example: + [ + { + "id": "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "name": "Conflicting-Policy-Name", + "created": "2020-01-01T00:00:00.000000Z", + "modified": "2020-01-01T00:00:00.000000Z", + "description": "This policy ensures compliance of xyz", + "ownerRef": + { + "type": "IDENTITY", + "id": "2c91808568c529c60168cca6f90c1313", + "name": "Owner Name", + }, + "externalPolicyReference": "XYZ policy", + "policyQuery": + "@access(id:2c9180866166b5b0016167c32ef31a66 OR + id:2c9180866166b5b0016167c32ef31a67) AND + @access(id:2c9180866166b5b0016167c32ef31a68 OR + id:2c9180866166b5b0016167c32ef31a69)", + "compensatingControls": + 'Have a manager review the transaction decisions for their + "out of compliance" employee', + "correctionAdvice": + "Based on the role of the employee, managers should remove + access that is not required for their job function.", + "state": "ENFORCED", + "tags": ["string"], + "creatorId": "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId": "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "violationOwnerAssignmentConfig": + { + "assignmentRule": "MANAGER", + "ownerRef": + { + "type": "IDENTITY", + "id": "2c91808568c529c60168cca6f90c1313", + "name": "Violation Owner Name", + }, + }, + "scheduled": true, + "type": "CONFLICTING_ACCESS_BASED", + "conflictingAccessCriteria": + { + "leftCriteria": + { + "name": "money-in", + "criteriaList": + [ + { + "type": "ENTITLEMENT", + "id": "2c9180866166b5b0016167c32ef31a66", + }, + { + "type": "ENTITLEMENT", + "id": "2c9180866166b5b0016167c32ef31a67", + }, + ], + }, + "rightCriteria": + { + "name": "money-out", + "criteriaList": + [ + { + "type": "ENTITLEMENT", + "id": "2c9180866166b5b0016167c32ef31a68", + }, + { + "type": "ENTITLEMENT", + "id": "2c9180866166b5b0016167c32ef31a69", + }, + ], + }, + }, + }, + { + "description": "Description", + "ownerRef": + { + "type": "IDENTITY", + "id": "2c918087682f9a86016839c05e8f1aff", + "name": "Owner Name", + }, + "externalPolicyReference": "New policy", + "policyQuery": "policy query implementation", + "compensatingControls": "Compensating controls", + "correctionAdvice": "Correction advice", + "tags": [], + "state": "ENFORCED", + "scheduled": false, + "creatorId": "2c918087682f9a86016839c05e8f1aff", + "modifierId": null, + "violationOwnerAssignmentConfig": null, + "type": "GENERAL", + "conflictingAccessCriteria": null, + "id": "52c11db4-733e-4c31-949a-766c95ec95f1", + "name": "General-Policy-Name", + "created": "2020-05-12T19:47:38Z", + "modified": "2020-05-12T19:47:38Z", + }, + ] + "400": + $ref: "../responses/400.yaml" + "401": + $ref: "../responses/401.yaml" + "403": + $ref: "../responses/403.yaml" + "429": + $ref: "../responses/429.yaml" + "500": + $ref: "../responses/500.yaml" diff --git a/static/api-specs/idn/v2025/paths/sod-policy-evaluate.yaml b/static/api-specs/idn/v2025/paths/sod-policy-evaluate.yaml new file mode 100644 index 000000000..8122baff7 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/sod-policy-evaluate.yaml @@ -0,0 +1,42 @@ +post: + security: + - userAuth: [idn:sod-violation:write] + operationId: startEvaluateSodPolicy + tags: + - SOD Policies + summary: Evaluate one policy by ID + description: >- + Runs the scheduled report for the policy retrieved by passed policy ID. + The report schedule is fetched from the policy retrieved by ID. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSodPolicies + description: The SOD policy ID to run. + example: ef38f943-47e9-4562-b5bb-8424a56397d8 + responses: + '200': + description: Reference to the violation report run task. + content: + application/json: + schema: + $ref: '../schemas/ReportResultReference.yaml' + example: { + "status": "PENDING", + "type": "REPORT_RESULT", + "id": "37b3b32a-f394-46f8-acad-b5223969fa68", + "name": "Multi Query Report" + } + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/sod-policy.yaml b/static/api-specs/idn/v2025/paths/sod-policy.yaml new file mode 100644 index 000000000..91c4d4ecd --- /dev/null +++ b/static/api-specs/idn/v2025/paths/sod-policy.yaml @@ -0,0 +1,564 @@ +get: + security: + - userAuth: [idn:sod-policy:read] + operationId: getSodPolicy + tags: + - SOD Policies + summary: Get SOD policy by ID + description: >- + This gets specified SOD policy. + + Requires role of ORG_ADMIN. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSodPolicies + description: The ID of the SOD Policy to retrieve. + example: ef38f943-47e9-4562-b5bb-8424a56397d8 + responses: + '200': + description: SOD policy ID. + content: + application/json: + schema: + $ref: '../schemas/SodPolicy.yaml' + examples: + Conflicting Access Based Policy: + value: + { + "id": "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "name": "Conflicting-Policy-Name", + "created": "2020-01-01T00:00:00.000000Z", + "modified": "2020-01-01T00:00:00.000000Z", + "description": "This policy ensures compliance of xyz", + "ownerRef": { + "type": "IDENTITY", + "id": "2c91808568c529c60168cca6f90c1313", + "name": "Owner Name" + }, + "externalPolicyReference": "XYZ policy", + "policyQuery": "@access(id:2c9180866166b5b0016167c32ef31a66 OR id:2c9180866166b5b0016167c32ef31a67) AND @access(id:2c9180866166b5b0016167c32ef31a68 OR id:2c9180866166b5b0016167c32ef31a69)", + "compensatingControls": "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "correctionAdvice": "Based on the role of the employee, managers should remove access that is not required for their job function.", + "state": "ENFORCED", + "tags": [ + "string" + ], + "creatorId": "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId": "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "violationOwnerAssignmentConfig": { + "assignmentRule": "MANAGER", + "ownerRef": { + "type": "IDENTITY", + "id": "2c91808568c529c60168cca6f90c1313", + "name": "Violation Owner Name" + } + }, + "scheduled": true, + "type": "CONFLICTING_ACCESS_BASED", + "conflictingAccessCriteria": { + "leftCriteria": { + "name": "money-in", + "criteriaList": [ + { + "type": "ENTITLEMENT", + "id": "2c9180866166b5b0016167c32ef31a66" + }, + { + "type": "ENTITLEMENT", + "id": "2c9180866166b5b0016167c32ef31a67" + } + ] + }, + "rightCriteria": { + "name": "money-out", + "criteriaList": [ + { + "type": "ENTITLEMENT", + "id": "2c9180866166b5b0016167c32ef31a68" + }, + { + "type": "ENTITLEMENT", + "id": "2c9180866166b5b0016167c32ef31a69" + } + ] + } + } + } + General Policy: + value: + { + "description": "Description", + "ownerRef": { + "type": "IDENTITY", + "id": "2c918087682f9a86016839c05e8f1aff", + "name": "Owner Name" + }, + "externalPolicyReference": "New policy", + "policyQuery": "policy query implementation", + "compensatingControls": "Compensating controls", + "correctionAdvice": "Correction advice", + "tags": [], + "state": "ENFORCED", + "scheduled": false, + "creatorId": "2c918087682f9a86016839c05e8f1aff", + "modifierId": null, + "violationOwnerAssignmentConfig": null, + "type": "GENERAL", + "conflictingAccessCriteria": null, + "id": "52c11db4-733e-4c31-949a-766c95ec95f1", + "name": "General-Policy-Name", + "created": "2020-05-12T19:47:38Z", + "modified": "2020-05-12T19:47:38Z" + } + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +put: + security: + - userAuth: [idn:sod-policy:write] + operationId: putSodPolicy + tags: + - SOD Policies + summary: Update SOD policy by ID + description: >- + This updates a specified SOD policy. + + Requires role of ORG_ADMIN. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSodPolicies + description: The ID of the SOD policy to update. + example: ef38f943-47e9-4562-b5bb-8424a56397d8 + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/SodPolicy.yaml' + examples: + Conflicting Access Based Policy: + value: + { + "name": "Conflicting-Policy-Name", + "description": "Modified Description", + + "externalPolicyReference": "XYZ policy", + "compensatingControls": "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "correctionAdvice": "Based on the role of the employee, managers should remove access that is not required for their job function.", + "state": "ENFORCED", + "tags": [ + "string" + ], + "violationOwnerAssignmentConfig": { + "assignmentRule": "MANAGER", + "ownerRef": { + "type": "IDENTITY", + "id": "2c91808568c529c60168cca6f90c1313", + "name": "Violation Owner Name" + } + }, + "scheduled": true, + "type": "CONFLICTING_ACCESS_BASED", + "conflictingAccessCriteria": { + "leftCriteria": { + "name": "money-in", + "criteriaList": [ + { + "type": "ENTITLEMENT", + "id": "2c9180866166b5b0016167c32ef31a66" + }, + { + "type": "ENTITLEMENT", + "id": "2c9180866166b5b0016167c32ef31a67" + } + ] + }, + "rightCriteria": { + "name": "money-out", + "criteriaList": [ + { + "type": "ENTITLEMENT", + "id": "2c9180866166b5b0016167c32ef31a68" + }, + { + "type": "ENTITLEMENT", + "id": "2c9180866166b5b0016167c32ef31a69" + } + ] + } + } + } + General Policy: + value: + { + "description": "Modified Description", + "ownerRef": { + "type": "IDENTITY", + "id": "2c918087682f9a86016839c05e8f1aff", + "name": "Owner Name" + }, + "externalPolicyReference": "New policy", + "policyQuery": "policy query implementation", + "compensatingControls": "Compensating controls", + "correctionAdvice": "Correction advice", + "tags": [], + "state": "ENFORCED", + "scheduled": false, + "creatorId": "2c918087682f9a86016839c05e8f1aff", + "modifierId": null, + "violationOwnerAssignmentConfig": null, + "type": "GENERAL", + "conflictingAccessCriteria": null, + "id": "52c11db4-733e-4c31-949a-766c95ec95f1", + "name": "General-Policy-Name", + "created": "2020-05-12T19:47:38Z", + "modified": "2020-05-12T19:47:38Z" + } + responses: + '200': + description: SOD Policy by ID + content: + application/json: + schema: + $ref: '../schemas/SodPolicy.yaml' + examples: + Conflicting Access Based Policy: + value: + { + "id": "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "name": "Conflicting-Policy-Name", + "created": "2020-01-01T00:00:00.000000Z", + "modified": "2020-01-01T00:00:00.000000Z", + "description": "Modified description", + "ownerRef": { + "type": "IDENTITY", + "id": "2c91808568c529c60168cca6f90c1313", + "name": "Owner Name" + }, + "externalPolicyReference": "XYZ policy", + "policyQuery": "@access(id:2c9180866166b5b0016167c32ef31a66 OR id:2c9180866166b5b0016167c32ef31a67) AND @access(id:2c9180866166b5b0016167c32ef31a68 OR id:2c9180866166b5b0016167c32ef31a69)", + "compensatingControls": "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "correctionAdvice": "Based on the role of the employee, managers should remove access that is not required for their job function.", + "state": "ENFORCED", + "tags": [ + "string" + ], + "creatorId": "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId": "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "violationOwnerAssignmentConfig": { + "assignmentRule": "MANAGER", + "ownerRef": { + "type": "IDENTITY", + "id": "2c91808568c529c60168cca6f90c1313", + "name": "Violation Owner Name" + } + }, + "scheduled": true, + "type": "CONFLICTING_ACCESS_BASED", + "conflictingAccessCriteria": { + "leftCriteria": { + "name": "money-in", + "criteriaList": [ + { + "type": "ENTITLEMENT", + "id": "2c9180866166b5b0016167c32ef31a66" + }, + { + "type": "ENTITLEMENT", + "id": "2c9180866166b5b0016167c32ef31a67" + } + ] + }, + "rightCriteria": { + "name": "money-out", + "criteriaList": [ + { + "type": "ENTITLEMENT", + "id": "2c9180866166b5b0016167c32ef31a68" + }, + { + "type": "ENTITLEMENT", + "id": "2c9180866166b5b0016167c32ef31a69" + } + ] + } + } + } + General Policy: + value: + { + "description": "Modified Description", + "ownerRef": { + "type": "IDENTITY", + "id": "2c918087682f9a86016839c05e8f1aff", + "name": "Owner Name" + }, + "externalPolicyReference": "New policy", + "policyQuery": "policy query implementation", + "compensatingControls": "Compensating controls", + "correctionAdvice": "Correction advice", + "tags": [], + "state": "ENFORCED", + "scheduled": false, + "creatorId": "2c918087682f9a86016839c05e8f1aff", + "modifierId": null, + "violationOwnerAssignmentConfig": null, + "type": "GENERAL", + "conflictingAccessCriteria": null, + "id": "52c11db4-733e-4c31-949a-766c95ec95f1", + "name": "General-Policy-Name", + "created": "2020-05-12T19:47:38Z", + "modified": "2020-05-12T19:47:38Z" + } + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +delete: + security: + - userAuth: [idn:sod-policy:write] + operationId: deleteSodPolicy + tags: + - SOD Policies + summary: Delete SOD policy by ID + description: >- + This deletes a specified SOD policy. + + Requires role of ORG_ADMIN. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSodPolicies + description: The ID of the SOD Policy to delete. + example: ef38f943-47e9-4562-b5bb-8424a56397d8 + - in: query + name: logical + schema: + type: boolean + default: true + description: >- + Indicates whether this is a soft delete (logical true) or a hard delete. + Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. + Hard delete vise versa permanently delete SOD request during this call. + example: true + required: false + responses: + '204': + description: No content. + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +patch: + security: + - userAuth: [idn:sod-policy:write] + operationId: patchSodPolicy + tags: + - SOD Policies + summary: Patch SOD policy by ID + description: >- + Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + Requires role of ORG_ADMIN. + + This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. + + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSodPolicies + description: The ID of the SOD policy being modified. + example: 2c918083-5d19-1a86-015d-28455b4a2329 + requestBody: + required: true + description: | + A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + The following fields are patchable: + * name + * description + * ownerRef + * externalPolicyReference + * compensatingControls + * correctionAdvice + * state + * tags + * violationOwnerAssignmentConfig + * scheduled + * conflictingAccessCriteria + content: + application/json-patch+json: + schema: + type: array + items: + $ref: '../schemas/JsonPatchOperation.yaml' + examples: + Conflicting Access Based Policy: + value: + - op: "replace" + path: "/description" + value: "Modified description" + - op: "replace" + path: "/conflictingAccessCriteria/leftCriteria/name" + value: "money-in-modified" + - op: "replace" + path: "/conflictingAccessCriteria/rightCriteria" + value: { + "name": "money-out-modified", + "criteriaList": [ + { + "type": "ENTITLEMENT", + "id": "2c918087682f9a86016839c0509c1ab2" + } + ] + } + General Policy: + value: + - op: "replace" + path: "/description" + value: "Modified description" + + responses: + '200': + description: >- + Indicates the PATCH operation succeeded, and returns the SOD policy's new representation. + content: + application/json: + schema: + $ref: '../schemas/SodPolicy.yaml' + examples: + Conflicting Access Based Policy: + value: + { + "id": "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "name": "Conflicting-Policy-Name", + "created": "2020-01-01T00:00:00.000000Z", + "modified": "2020-01-01T00:00:00.000000Z", + "description": "Modified description", + "ownerRef": { + "type": "IDENTITY", + "id": "2c91808568c529c60168cca6f90c1313", + "name": "Owner Name" + }, + "externalPolicyReference": "XYZ policy", + "policyQuery": "@access(id:2c9180866166b5b0016167c32ef31a66 OR id:2c9180866166b5b0016167c32ef31a67) AND @access(id:2c918087682f9a86016839c0509c1ab2)", + "compensatingControls": "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "correctionAdvice": "Based on the role of the employee, managers should remove access that is not required for their job function.", + "state": "ENFORCED", + "tags": [ + "string" + ], + "creatorId": "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId": "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "violationOwnerAssignmentConfig": { + "assignmentRule": "MANAGER", + "ownerRef": { + "type": "IDENTITY", + "id": "2c91808568c529c60168cca6f90c1313", + "name": "Violation Owner Name" + } + }, + "scheduled": true, + "type": "CONFLICTING_ACCESS_BASED", + "conflictingAccessCriteria": { + "leftCriteria": { + "name": "money-in-modified", + "criteriaList": [ + { + "type": "ENTITLEMENT", + "id": "2c9180866166b5b0016167c32ef31a66" + }, + { + "type": "ENTITLEMENT", + "id": "2c9180866166b5b0016167c32ef31a67" + } + ] + }, + "rightCriteria": { + "name": "money-out-modified", + "criteriaList": [ + { + "type": "ENTITLEMENT", + "id": "2c918087682f9a86016839c0509c1ab2" + } + ] + } + } + } + General Policy: + value: + { + "description": "Modified description", + "ownerRef": { + "type": "IDENTITY", + "id": "2c918087682f9a86016839c05e8f1aff", + "name": "Owner Name" + }, + "externalPolicyReference": "New policy", + "policyQuery": "policy query implementation", + "compensatingControls": "Compensating controls", + "correctionAdvice": "Correction advice", + "tags": [], + "state": "ENFORCED", + "scheduled": false, + "creatorId": "2c918087682f9a86016839c05e8f1aff", + "modifierId": null, + "violationOwnerAssignmentConfig": null, + "type": "GENERAL", + "conflictingAccessCriteria": null, + "id": "52c11db4-733e-4c31-949a-766c95ec95f1", + "name": "General-Policy-Name", + "created": "2020-05-12T19:47:38Z", + "modified": "2020-05-12T19:47:38Z" + } + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/sod-report-run.yaml b/static/api-specs/idn/v2025/paths/sod-report-run.yaml new file mode 100644 index 000000000..b3f126f3b --- /dev/null +++ b/static/api-specs/idn/v2025/paths/sod-report-run.yaml @@ -0,0 +1,44 @@ +post: + security: + - userAuth: [idn:sod-violation:write] + operationId: startSodPolicy + tags: + - SOD Policies + summary: Runs SOD policy violation report + description: >- + This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with + violation limit exceeded message. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSodPolicies + description: The SOD policy ID to run. + example: ef38f943-47e9-4562-b5bb-8424a56397d8 + responses: + '200': + description: Reference to the violation report run task. + content: + application/json: + schema: + $ref: '../schemas/ReportResultReference.yaml' + example: { + "status": "PENDING", + "type": "REPORT_RESULT", + "id": "2e8d8180-24bc-4d21-91c6-7affdb473b0d", + "name": "policy-xyz" + } + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/sod-schedule.yaml b/static/api-specs/idn/v2025/paths/sod-schedule.yaml new file mode 100644 index 000000000..8bb190f7f --- /dev/null +++ b/static/api-specs/idn/v2025/paths/sod-schedule.yaml @@ -0,0 +1,109 @@ +get: + security: + - userAuth: [idn:sod-policy:read] + operationId: getSodPolicySchedule + tags: + - SOD Policies + summary: Get SOD policy schedule + description: >- + This endpoint gets a specified SOD policy's schedule. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSodPolicies + description: The ID of the SOD policy schedule to retrieve. + example: ef38f943-47e9-4562-b5bb-8424a56397d8 + responses: + '200': + description: SOD policy schedule. + content: + application/json: + schema: + $ref: '../schemas/SodPolicySchedule.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +put: + security: + - userAuth: [idn:sod-policy:write] + operationId: putPolicySchedule + tags: + - SOD Policies + summary: Update SOD Policy schedule + description: >- + This updates schedule for a specified SOD policy. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSodPolicies + description: The ID of the SOD policy to update its schedule. + example: ef38f943-47e9-4562-b5bb-8424a56397d8 + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/SodPolicySchedule.yaml' + responses: + '200': + description: Created or updated SOD policy schedule. + content: + application/json: + schema: + $ref: '../schemas/SodPolicySchedule.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +delete: + security: + - userAuth: [idn:sod-policy:write] + operationId: deleteSodPolicySchedule + tags: + - SOD Policies + summary: Delete SOD policy schedule + description: >- + This deletes schedule for a specified SOD policy by ID. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSodPolicies + description: The ID of the SOD policy the schedule must be deleted for. + example: ef38f943-47e9-4562-b5bb-8424a56397d8 + responses: + '204': + description: No content response. + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/sod-violation-check.yaml b/static/api-specs/idn/v2025/paths/sod-violation-check.yaml new file mode 100644 index 000000000..7ec90eda3 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/sod-violation-check.yaml @@ -0,0 +1,57 @@ +post: + operationId: startViolationCheck + tags: + - SOD Policies + summary: Check SOD violations + description: >- + This API initiates a SOD policy verification asynchronously. + + + A token with ORG_ADMIN authority is required to call this API. + + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/IdentityWithNewAccess.yaml' + example: + { + "identityId": "2c91808568c529c60168cca6f90c1313", + "accessRefs": [ + { + "type": "ENTITLEMENT", + "id": "2c918087682f9a86016839c050861ab1", + "name": "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, + { + "type": "ENTITLEMENT", + "id": "2c918087682f9a86016839c0509c1ab2", + "name": "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } + ], + "clientMetadata": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + } + } + responses: + '202': + description: Request ID with a timestamp. + content: + application/json: + schema: + $ref: '../schemas/SodViolationCheck.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/sod-violation-report-status.yaml b/static/api-specs/idn/v2025/paths/sod-violation-report-status.yaml new file mode 100644 index 000000000..83578b0b8 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/sod-violation-report-status.yaml @@ -0,0 +1,43 @@ +get: + security: + - userAuth: [idn:sod-violation:read] + operationId: getSodViolationReportRunStatus + tags: + - SOD Policies + summary: Get violation report run status + description: >- + This gets the status for a violation report run task that has already been invoked. + parameters: + - in: path + name: reportResultId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: getSodAllReportRunStatus + description: The ID of the report reference to retrieve. + example: 2e8d8180-24bc-4d21-91c6-7affdb473b0d + responses: + '200': + description: Status of the violation report run task. + content: + application/json: + schema: + $ref: '../schemas/ReportResultReference.yaml' + example: { + "status": "SUCCESS", + "type": "REPORT_RESULT", + "id": "2e8d8180-24bc-4d21-91c6-7affdb473b0d", + "name": "policy-xyz" + } + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/sod-violation-report.yaml b/static/api-specs/idn/v2025/paths/sod-violation-report.yaml new file mode 100644 index 000000000..06c7223d5 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/sod-violation-report.yaml @@ -0,0 +1,43 @@ +get: + security: + - userAuth: [idn:sod-violation:read] + operationId: getSodViolationReportStatus + tags: + - SOD Policies + summary: Get SOD violation report status + description: >- + This gets the status for a violation report run task that has already been invoked. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: startSodPolicy + description: The ID of the violation report to retrieve status for. + example: ef38f943-47e9-4562-b5bb-8424a56397d8 + responses: + '200': + description: Status of the violation report run task. + content: + application/json: + schema: + $ref: '../schemas/ReportResultReference.yaml' + example: { + "status": "SUCCESS", + "type": "REPORT_RESULT", + "id": "2e8d8180-24bc-4d21-91c6-7affdb473b0d", + "name": "policy-xyz" + } + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/sod-violations-check.yaml b/static/api-specs/idn/v2025/paths/sod-violations-check.yaml new file mode 100644 index 000000000..e7ea55fc4 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/sod-violations-check.yaml @@ -0,0 +1,57 @@ +post: + security: + - userAuth: [idn:sod-violation:read] + x-sailpoint-userLevels: + - ORG_ADMIN + operationId: startViolationCheck + tags: + - SOD Violations + summary: Check SOD violations + description: >- + This API initiates a SOD policy verification asynchronously. + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/IdentityWithNewAccess.yaml' + example: + { + "identityId": "2c91808568c529c60168cca6f90c1313", + "accessRefs": [ + { + "type": "ENTITLEMENT", + "id": "2c918087682f9a86016839c050861ab1", + "name": "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, + { + "type": "ENTITLEMENT", + "id": "2c918087682f9a86016839c0509c1ab2", + "name": "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } + ], + "clientMetadata": { + "additionalProp1": "string", + "additionalProp2": "string", + "additionalProp3": "string" + } + } + responses: + '202': + description: Request ID with a timestamp. + content: + application/json: + schema: + $ref: '../schemas/SodViolationCheck.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/sod-violations-predict.yaml b/static/api-specs/idn/v2025/paths/sod-violations-predict.yaml new file mode 100644 index 000000000..f47fd8f40 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/sod-violations-predict.yaml @@ -0,0 +1,54 @@ +post: + security: + - userAuth: [idn:sod-violation:read] + - applicationAuth: [idn:sod-violation:read] + x-sailpoint-userLevels: + - ORG_ADMIN + operationId: startPredictSodViolations + tags: + - SOD Violations + summary: Predict SOD violations for identity. + description: >- + This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. + Returns the violations that would be caused. + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/sod/models/IdentityWithNewAccess.yaml' + example: + { + "identityId": "2c91808568c529c60168cca6f90c1313", + "accessRefs": [ + { + "type": "ENTITLEMENT", + "id": "2c918087682f9a86016839c050861ab1", + "name": "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, + { + "type": "ENTITLEMENT", + "id": "2c918087682f9a86016839c0509c1ab2", + "name": "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } + ] + } + responses: + '200': + description: Violation Contexts + content: + application/json: + schema: + $ref: '../schemas/sod/models/ViolationPrediction.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/sod/arm-risk.yaml b/static/api-specs/idn/v2025/paths/sod/arm-risk.yaml new file mode 100644 index 000000000..33e255dcf --- /dev/null +++ b/static/api-specs/idn/v2025/paths/sod/arm-risk.yaml @@ -0,0 +1,41 @@ +get: + operationId: getArmRiskById + tags: + - SOD Policies + summary: Gets the specified ARM risk. + description: >- + This API gets the specified ARM risk. + + + Any authenticated token can call this API. + security: + - userAuth: [idn:sod-policy:read, idn:sod-policy:manage] + parameters: + - in: path + name: id + schema: + type: string + required: true + description: >- + The composite ID of the ARM Risk. + It should consist of a jobId, rulebookId, and a riskCode; each separated by a "!" + example: 52435!246635!BS_04 + responses: + '200': + description: ARM Risk + content: + application/json: + schema: + $ref: '../../schemas/sod/models/ArmRisk.yaml' + '400': + $ref: '../../responses/400.yaml' + '401': + $ref: '../../responses/401.yaml' + '403': + $ref: '../../responses/403.yaml' + '404': + $ref: '../../responses/404.yaml' + '429': + $ref: '../../responses/429.yaml' + '500': + $ref: '../../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/sod/predict-violations.yaml b/static/api-specs/idn/v2025/paths/sod/predict-violations.yaml new file mode 100644 index 000000000..14da65b5e --- /dev/null +++ b/static/api-specs/idn/v2025/paths/sod/predict-violations.yaml @@ -0,0 +1,56 @@ +post: + operationId: startPredictSodViolations + tags: + - SOD Violations + summary: Predict SOD violations for identity. + deprecated: true + security: + - userAuth: [ idn:sod-violation:read ] + description: >- + This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. + Returns the violations that would be caused. + + + A token with ORG_ADMIN or API authority is required to call this API. + + requestBody: + required: true + content: + application/json: + schema: + $ref: '../../schemas/sod/models/IdentityWithNewAccess.yaml' + example: + { + "identityId": "2c91808568c529c60168cca6f90c1313", + "accessRefs": [ + { + "type": "ENTITLEMENT", + "id": "2c918087682f9a86016839c050861ab1", + "name": "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, + { + "type": "ENTITLEMENT", + "id": "2c918087682f9a86016839c0509c1ab2", + "name": "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } + ] + } + responses: + '200': + description: Violation Contexts + content: + application/json: + schema: + $ref: '../../schemas/sod/models/ViolationPrediction.yaml' + '400': + $ref: '../../responses/400.yaml' + '401': + $ref: '../../responses/401.yaml' + '403': + $ref: '../../responses/403.yaml' + '404': + $ref: '../../responses/404.yaml' + '429': + $ref: '../../responses/429.yaml' + '500': + $ref: '../../responses/500.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/source-accounts-schema.yaml b/static/api-specs/idn/v2025/paths/source-accounts-schema.yaml new file mode 100644 index 000000000..0cd03c83c --- /dev/null +++ b/static/api-specs/idn/v2025/paths/source-accounts-schema.yaml @@ -0,0 +1,92 @@ +get: + tags: + - Sources + summary: Downloads source accounts schema template + description: >- + This API downloads the CSV schema that defines the account attributes on a source. + + >**NOTE: This API is designated only for Delimited File sources.** + operationId: getAccountsSchema + parameters: + - in: path + name: id + required: true + x-sailpoint-resource-operation-id: listSources + schema: + type: string + description: The Source id + example: '8c190e6787aa4ed9a90bd9d5344523fb' + responses: + '200': + description: Successfully downloaded the file + content: + text/csv: + example: "id,name,givenName,familyName,e-mail,location,manager,groups,startDate,endDate" + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + security: + - userAuth: [idn:source-schema:read] +post: + tags: + - Sources + summary: Uploads source accounts schema template + description: >- + This API uploads a source schema template file to configure a source's account attributes. + + + To retrieve the file to modify and upload, log into Identity Now. + + + Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** + + + >**NOTE: This API is designated only for Delimited File sources.** + operationId: importAccountsSchema + parameters: + - in: path + name: id + required: true + x-sailpoint-resource-operation-id: listSources + schema: + type: string + description: The Source id + example: '8c190e6787aa4ed9a90bd9d5344523fb' + requestBody: + required: true + content: + multipart/form-data: + schema: + type: object + properties: + file: + type: string + format: binary + responses: + '200': + description: Successfully uploaded the file + content: + application/json: + schema: + $ref: '../schemas/Schema.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + security: + - userAuth: [idn:source-schema:manage] diff --git a/static/api-specs/idn/v2025/paths/source-aggregation-state.yaml b/static/api-specs/idn/v2025/paths/source-aggregation-state.yaml new file mode 100644 index 000000000..ec22a88e3 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/source-aggregation-state.yaml @@ -0,0 +1,39 @@ +post: + operationId: updateAggregationState + tags: + - Sources + summary: Update Aggregation State + description: >- + This API updates the aggregation state for the source. + + A token with API authority is required to call this API. + # security: + # - oauth2: [API] + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSources + description: The source id + example: 2c93805454fb79640134ffda7c6903d7 + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/AggregationState.yaml' + responses: + '204': + description: The aggregation state is updated. + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/source-connections.yaml b/static/api-specs/idn/v2025/paths/source-connections.yaml new file mode 100644 index 000000000..274802395 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/source-connections.yaml @@ -0,0 +1,41 @@ +get: + operationId: getSourceConnections + security: + - userAuth: [ idn:sources:read ] + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN + tags: + - Sources + summary: Get Source Connections by ID + description: >- + Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC). + parameters: + - in: path + name: sourceId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSources + description: Source ID. + example: 2c9180835d191a86015d28455b4a2329 + responses: + '200': + description: Source Connections object. + content: + application/json: + schema: + $ref: '../schemas/SourceConnectionsDto.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/source-connector-check-connection.yaml b/static/api-specs/idn/v2025/paths/source-connector-check-connection.yaml new file mode 100644 index 000000000..ebd461712 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/source-connector-check-connection.yaml @@ -0,0 +1,43 @@ +post: + operationId: testSourceConnection + tags: + - Sources + summary: Check connection for source connector. + description: >- + This endpoint validates that the configured credentials are valid + and will properly authenticate with the source identified by the sourceId path + parameter. + security: + - userAuth: + - idn:source-connector:manage + x-sailpoint-userLevels: + - ORG_ADMIN + parameters: + - in: path + name: sourceId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSources + description: The ID of the Source. + example: cef3ee201db947c5912551015ba0c679 + responses: + '200': + description: The result of checking connection to the source connector with + response from it. + content: + application/json: + schema: + $ref: ../schemas/StatusResponse.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/source-connector-initiate-extract.yaml b/static/api-specs/idn/v2025/paths/source-connector-initiate-extract.yaml new file mode 100644 index 000000000..79d9bf4fb --- /dev/null +++ b/static/api-specs/idn/v2025/paths/source-connector-initiate-extract.yaml @@ -0,0 +1,78 @@ +post: + operationId: initiateExtract + tags: + - Sources + summary: Initiate extraction request in connector + description: >- + Initiates an extraction request from the source connector for security-extract, utilization-extract, changelog-extract etc from ERP systems. + + A token with ORG_ADMIN authority is required to call this API. + security: + - userAuth: [idn:source-connector:manage] + parameters: + - in: path + name: sourceId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSources + description: The ID of the Source + example: cef3ee201db947c5912551015ba0c679 + - in: path + name: messageType + schema: + type: string + enum: + - security-extract + - utilization-extract + - changelog-extract + required: true + description: The type of extract request + example: security-extract + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/ExtractRequest.yaml' + examples: + securityExtract: + summary: Security Extract request + value: + referenceId: 2c9180837ab5b716017ab7c6c9ef1e20 + callbackUrl: https://www.example.com + utilizationExtract: + summary: Utilization Extract request + value: + referenceId: 2c9180837ab5b716017ab7c6c9ef1e20 + fromTime: "2022-02-07T20:13:29.356648026Z" + endTime: "2022-02-07T20:13:29.356648026Z" + callbackUrl: https://www.example.com + attribute: + filters: ["USERID in (1015643,0)", + "TECH_STACK='AUDIT'"] + changelogExtract: + summary: Change Log Extract request + value: + referenceId: 2c9180837ab5b716017ab7c6c9ef1e20 + fromTime: "2022-02-07T20:13:29.356648026Z" + endTime: "2022-02-07T20:13:29.356648026Z" + callbackUrl: https://www.example.com + attribute: + username: JSMITH + responses: + '202': + description: Accepted - Returned if the extact request was successfully accepted into the system. + $ref: '../responses/202.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/source-connector-peek-resource-objects.yaml b/static/api-specs/idn/v2025/paths/source-connector-peek-resource-objects.yaml new file mode 100644 index 000000000..1bf9f41c9 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/source-connector-peek-resource-objects.yaml @@ -0,0 +1,50 @@ +post: + operationId: searchResourceObjects + tags: + - Sources + summary: Peek source connector's resource objects + description: >- + Retrieves a sample of data returned from account and group aggregation + requests. + security: + - userAuth: + - idn:source-connector:manage + x-sailpoint-userLevels: + - ORG_ADMIN + parameters: + - in: path + name: sourceId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSources + description: The ID of the Source + example: cef3ee201db947c5912551015ba0c679 + requestBody: + required: true + content: + application/json: + schema: + $ref: ../schemas/ResourceObjectsRequest.yaml + example: + objectType: resource + maxCount: 50 + responses: + '200': + description: List of resource objects that was fetched from the source connector. + content: + application/json: + schema: + $ref: ../schemas/ResourceObjectsResponse.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/source-connector-ping-cluster.yaml b/static/api-specs/idn/v2025/paths/source-connector-ping-cluster.yaml new file mode 100644 index 000000000..ef5a8da63 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/source-connector-ping-cluster.yaml @@ -0,0 +1,41 @@ +post: + operationId: pingCluster + tags: + - Sources + summary: Ping cluster for source connector + description: >- + This endpoint validates that the cluster being used by the source + is reachable from IdentityNow. + security: + - userAuth: + - idn:source-connector:manage + x-sailpoint-userLevels: + - ORG_ADMIN + parameters: + - in: path + name: sourceId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSources + description: The ID of the Source + example: cef3ee201db947c5912551015ba0c679 + responses: + '200': + description: The result of pinging connection with the source connector. + content: + application/json: + schema: + $ref: ../schemas/StatusResponse.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/source-connector-state.yaml b/static/api-specs/idn/v2025/paths/source-connector-state.yaml new file mode 100644 index 000000000..d4d2a336d --- /dev/null +++ b/static/api-specs/idn/v2025/paths/source-connector-state.yaml @@ -0,0 +1,49 @@ +post: + operationId: updateConnectorState + tags: + - Sources + summary: Update Connector State + description: >- + This API updates connector states of a specific source. + + A token with API authority is required to call this API. + # security: + # - oauth2: [API] + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSources + description: The Source ID + example: 5893805454fb79640134ffda7c6903d7 + requestBody: + required: true + content: + application/json: + schema: + type: object + description: The configuration is specific to a connector. It can differ from type to type. + example: + healthCheckTimeout: 30 + authSearchAttributes: [ + "cn", + "uid", + "mail" + ] + responses: + '204': + description: The connector states are updated. + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/source-connector-test-configuration.yaml b/static/api-specs/idn/v2025/paths/source-connector-test-configuration.yaml new file mode 100644 index 000000000..71b0dfa2f --- /dev/null +++ b/static/api-specs/idn/v2025/paths/source-connector-test-configuration.yaml @@ -0,0 +1,43 @@ +post: + operationId: testSourceConfiguration + tags: + - Sources + summary: Test configuration for source connector + description: >- + This endpoint performs a more detailed validation of the source''s + configuration that can take longer than the lighter weight credential validation + performed by the checkConnection API. + security: + - userAuth: + - idn:source-connector:manage + x-sailpoint-userLevels: + - ORG_ADMIN + parameters: + - in: path + name: sourceId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSources + description: The ID of the Source + example: cef3ee201db947c5912551015ba0c679 + responses: + '200': + description: The result of testing source connector configuration with response + from it. + content: + application/json: + schema: + $ref: ../schemas/StatusResponse.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/source-connectors-source-config.yaml b/static/api-specs/idn/v2025/paths/source-connectors-source-config.yaml new file mode 100644 index 000000000..3e67067fc --- /dev/null +++ b/static/api-specs/idn/v2025/paths/source-connectors-source-config.yaml @@ -0,0 +1,68 @@ +get: + operationId: getSourceConfig + tags: + - Sources + summary: Gets source config with language-translations + security: + - userAuth: [] + x-sailpoint-userLevels: + - ORG_ADMIN + description: >- + Looks up and returns the source config for the requested source id + after populating the source config values and applying language translations. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSources + description: The Source id + example: cef3ee201db947c5912551015ba0c679 + - in: query + name: locale + schema: + type: string + enum: + - de + - false + - fi + - sv + - ru + - pt + - ko + - zh-TW + - en + - it + - fr + - zh-CN + - hu + - es + - cs + - ja + - pl + - da + - nl + description: The locale to apply to the config. If no viable locale is given, + it will default to "en" + example: en + required: false + responses: + '200': + description: A Connector Detail object + content: + application/json: + schema: + $ref: ../schemas/ConnectorDetail.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/source-entitlements-schema.yaml b/static/api-specs/idn/v2025/paths/source-entitlements-schema.yaml new file mode 100644 index 000000000..50eb15956 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/source-entitlements-schema.yaml @@ -0,0 +1,105 @@ +get: + tags: + - Sources + summary: Downloads source entitlements schema template + description: >- + This API downloads the CSV schema that defines the entitlement attributes on a source. + + + >**NOTE: This API is designated only for Delimited File sources.** + operationId: getEntitlementsSchema + parameters: + - in: path + name: id + required: true + x-sailpoint-resource-operation-id: listSources + schema: + type: string + description: The Source id + example: '8c190e6787aa4ed9a90bd9d5344523fb' + - in: query + name: schemaName + schema: + type: string + description: Name of entitlement schema + example: '?schemaName=group' + responses: + '200': + description: Successfully downloaded the file + content: + text/csv: + example: "id,name,displayName,created,description,modified,entitlements,groups,permissions" + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + security: + - userAuth: [idn:source-schema:read] +post: + tags: + - Sources + summary: Uploads source entitlements schema template + description: >- + This API uploads a source schema template file to configure a source's entitlement attributes. + + + To retrieve the file to modify and upload, log into Identity Now. + + + Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** + + + >**NOTE: This API is designated only for Delimited File sources.** + operationId: importEntitlementsSchema + parameters: + - in: path + name: id + required: true + x-sailpoint-resource-operation-id: listSources + schema: + type: string + description: The Source id + example: '8c190e6787aa4ed9a90bd9d5344523fb' + - in: query + name: schemaName + schema: + type: string + description: Name of entitlement schema + example: '?schemaName=group' + requestBody: + required: true + content: + multipart/form-data: + schema: + type: object + properties: + file: + type: string + format: binary + responses: + '200': + description: Successfully uploaded the file + content: + application/json: + schema: + $ref: '../schemas/Schema.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + security: + - userAuth: [idn:source-schema:manage] diff --git a/static/api-specs/idn/v2025/paths/source-health.yaml b/static/api-specs/idn/v2025/paths/source-health.yaml new file mode 100644 index 000000000..6d4f4bc91 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/source-health.yaml @@ -0,0 +1,39 @@ +get: + operationId: getSourceHealth + security: + - userAuth: [ idn:sources:read ] + tags: + - Sources + summary: Fetches source health by id + description: >- + This endpoint fetches source health by source's id + + parameters: + - in: path + name: sourceId + required: true + x-sailpoint-resource-operation-id: listSources + schema: + type: string + description: The Source id. + example: 2c9180835d191a86015d28455b4a2329 + responses: + '200': + description: >- + Fetched source health successfully + content: + application/json: + schema: + $ref: '../schemas/SourceHealthDto.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/source-schedule.yaml b/static/api-specs/idn/v2025/paths/source-schedule.yaml new file mode 100644 index 000000000..bac2ee91a --- /dev/null +++ b/static/api-specs/idn/v2025/paths/source-schedule.yaml @@ -0,0 +1,172 @@ +get: + operationId: getSourceSchedule + security: + - userAuth: [ idn:sources:read ] + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN + tags: + - Sources + summary: Get Source Schedule by Type + description: | + Get the source schedule by type in Identity Security Cloud (ISC). + parameters: + - in: path + name: sourceId + required: true + x-sailpoint-resource-operation-id: listSources + schema: + type: string + description: The Source id. + example: 2c9180835d191a86015d28455b4a2329 + - in: path + name: scheduleType + schema: + type: string + enum: + - ACCOUNT_AGGREGATION + - GROUP_AGGREGATION + required: true + description: The Schedule type. + example: ACCOUNT_AGGREGATION + responses: + '200': + description: The requested Schedule was successfully retrieved. + content: + application/json: + schema: + $ref: '../schemas/sources/Schedule.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +patch: + operationId: updateSourceSchedule + security: + - userAuth: [ idn:sources:update ] + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN + tags: + - Sources + summary: Update Source Schedule (Partial) + description: | + Use this API to selectively update an existing Schedule using a JSONPatch payload. + + The following schedule fields are immutable and cannot be updated: + + - type + + parameters: + - in: path + name: sourceId + required: true + x-sailpoint-resource-operation-id: listSources + schema: + type: string + description: The Source id. + example: 2c9180835d191a86015d28455b4a2329 + - in: path + name: scheduleType + schema: + type: string + enum: + - ACCOUNT_AGGREGATION + - GROUP_AGGREGATION + required: true + description: The Schedule type. + example: ACCOUNT_AGGREGATION + requestBody: + required: true + description: The JSONPatch payload used to update the schedule. + content: + application/json-patch+json: + schema: + type: array + items: + $ref: '../schemas/JsonPatchOperation.yaml' + examples: + add-attribute: + summary: Replace an attribute of the schedule + value: [ + { + "op": "replace", + "path": "/cronExpression", + "value": "0 0 6 * * ?" + } + ] + responses: + '200': + description: The Schedule was successfully updated. + content: + application/json: + schema: + $ref: '../schemas/sources/Schedule.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +delete: + operationId: deleteSourceSchedule + security: + - userAuth: [ idn:sources:update ] + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN + tags: + - Sources + summary: Delete Source Schedule by type. + parameters: + - in: path + name: sourceId + required: true + x-sailpoint-resource-operation-id: listSources + schema: + type: string + description: The Source id. + example: 2c9180835d191a86015d28455b4a2329 + - in: path + name: scheduleType + schema: + type: string + enum: + - ACCOUNT_AGGREGATION + - GROUP_AGGREGATION + required: true + description: The Schedule type. + example: ACCOUNT_AGGREGATION + responses: + '204': + $ref: '../responses/204.yaml' + description: The Schedule was successfully deleted. + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/source-schedules.yaml b/static/api-specs/idn/v2025/paths/source-schedules.yaml new file mode 100644 index 000000000..6801cfd00 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/source-schedules.yaml @@ -0,0 +1,96 @@ + +get: + operationId: getSourceSchedules + security: + - userAuth: [ idn:sources:read ] + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN + tags: + - Sources + summary: List Schedules on Source + description: | + Use this API to list the schedules that exist on the specified source in Identity Security Cloud (ISC). + :::info + This endpoint uses a **cron expression** to schedule a task, following standard **cron job syntax**. + + For example, `0 0 12 1/1 * ? *` runs the task **daily at 12:00 PM**. + + **Days of the week are represented as 1-7 (Sunday-Saturday).** + ::: + parameters: + - in: path + name: sourceId + required: true + x-sailpoint-resource-operation-id: listSources + schema: + type: string + description: Source ID. + example: 2c9180835d191a86015d28455b4a2329 + responses: + '200': + description: The schedules were successfully retrieved. + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/sources/Schedule.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +post: + operationId: createSourceSchedule + security: + - userAuth: [ idn:sources:update ] + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN + tags: + - Sources + summary: Create Schedule on Source + description: | + Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC). + parameters: + - in: path + name: sourceId + required: true + x-sailpoint-resource-operation-id: listSources + schema: + type: string + description: Source ID. + example: 2c9180835d191a86015d28455b4a2329 + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/sources/Schedule.yaml' + responses: + '201': + description: The schedule was successfully created on the specified source. + content: + application/json: + schema: + $ref: '../schemas/sources/Schedule.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/source-synchronize-attributes.yaml b/static/api-specs/idn/v2025/paths/source-synchronize-attributes.yaml new file mode 100644 index 000000000..742f1c7a9 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/source-synchronize-attributes.yaml @@ -0,0 +1,52 @@ +post: + operationId: syncAttributesForSource + tags: + - Sources + summary: Synchronize single source attributes. + security: + - userAuth: [] + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + description: This end-point performs attribute synchronization for a selected source. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSources + description: The Source id + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '202': + description: A Source Sync job + content: + application/json: + schema: + $ref: ../schemas/SourceSyncJob.yaml + example: + id: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + status: IN_PROGRESS + payload: + type: SYNCHRONIZE_SOURCE_ATTRIBUTES + dataJson: '{"sourceId":"2c918083746f642c01746f990884012a"}' + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/source-upload-connector-file.yaml b/static/api-specs/idn/v2025/paths/source-upload-connector-file.yaml new file mode 100644 index 000000000..4c4699266 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/source-upload-connector-file.yaml @@ -0,0 +1,49 @@ +post: + operationId: importConnectorFile + security: + - userAuth: [ idn:sources-admin:manage ] + x-sailpoint-userLevels: + - ORG_ADMIN + tags: + - Sources + summary: Upload connector file to source + parameters: + - in: path + name: sourceId + required: true + x-sailpoint-resource-operation-id: listSources + schema: + type: string + description: The Source id. + example: 2c9180835d191a86015d28455b4a2329 + description: >- + This uploads a supplemental source connector file (like jdbc driver jars) to a source's S3 bucket. + This also sends ETS and Audit events. + requestBody: + required: true + content: + multipart/form-data: + schema: + type: object + properties: + file: + type: string + format: binary + responses: + '200': + description: >- + Uploaded the file successfully and sent all post-upload events + content: + application/json: + schema: + $ref: '../schemas/Source.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/source-usage-status.yaml b/static/api-specs/idn/v2025/paths/source-usage-status.yaml new file mode 100644 index 000000000..b8a619ea0 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/source-usage-status.yaml @@ -0,0 +1,35 @@ +get: + tags: + - Source Usages + summary: Finds status of source usage + description: >- + This API returns the status of the source usage insights setup by IDN source ID. + operationId: getStatusBySourceId + parameters: + - name: sourceId + in: path + description: ID of IDN source + required: true + x-sailpoint-resource-operation-id: listSources + schema: + type: string + example: '2c9180835d191a86015d28455b4a2329' + security: + - userAuth: [ idn:accounts:read ] + responses: + '200': + description: Status of the source usage insights setup by IDN source ID. + content: + application/json: + schema: + $ref: '../schemas/SourceUsageStatus.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/source-usages.yaml b/static/api-specs/idn/v2025/paths/source-usages.yaml new file mode 100644 index 000000000..be85dcd65 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/source-usages.yaml @@ -0,0 +1,51 @@ +get: + tags: + - Source Usages + summary: Returns source usage insights + description: >- + This API returns a summary of source usage insights for past 12 months. + operationId: getUsagesBySourceId + parameters: + - name: sourceId + in: path + description: ID of IDN source + required: true + x-sailpoint-resource-operation-id: listSources + schema: + type: string + example: '2c9180835d191a86015d28455b4a2329' + - $ref: '../parameters/limit.yaml' + - $ref: '../parameters/offset.yaml' + - $ref: '../parameters/count.yaml' + - in: query + name: sorters + schema: + type: string + format: comma-separated + description: >- + Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **date** + example: -date + security: + - userAuth: [ idn:accounts:read ] + responses: + '200': + description: Summary of source usage insights for past 12 months. + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/SourceUsage.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/source.yaml b/static/api-specs/idn/v2025/paths/source.yaml new file mode 100644 index 000000000..fa5dc75be --- /dev/null +++ b/static/api-specs/idn/v2025/paths/source.yaml @@ -0,0 +1,322 @@ +get: + operationId: getSource + security: + - userAuth: [ idn:sources:read ] + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN + tags: + - Sources + summary: Get Source by ID + description: >- + Use this API to get a source by a specified ID in Identity Security Cloud (ISC). + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSources + description: Source ID. + example: 2c9180835d191a86015d28455b4a2329 + responses: + '200': + description: Source object. + content: + application/json: + schema: + $ref: '../schemas/Source.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +put: + operationId: putSource + security: + - userAuth: [ idn:sources:manage ] + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN + tags: + - Sources + summary: Update Source (Full) + description: | + Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. + + These fields are immutable, so they cannot be changed: + + * id + * type + * authoritative + * connector + * connectorClass + * passwordPolicies + + Attempts to modify these fields will result in a 400 error. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSources + description: Source ID. + example: 2c9180835d191a86015d28455b4a2329 + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/Source.yaml' + responses: + '200': + description: >- + Updated Source object. Any passwords will only show the the encrypted cipher-text so that they aren't decryptable + in Identity Security Cloud (ISC) cloud-based services, per ISC security design. + content: + application/json: + schema: + $ref: '../schemas/Source.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +patch: + operationId: updateSource + security: + - userAuth: [ idn:sources:manage ] + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN + tags: + - Sources + summary: Update Source (Partial) + description: | + Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the + [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + These fields are immutable, so they cannot be changed: + + * id + * type + * authoritative + * created + * modified + * connector + * connectorClass + * passwordPolicies + + Attempts to modify these fields will result in a 400 error. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSources + description: Source ID. + example: 2c9180835d191a86015d28455b4a2329 + requestBody: + required: true + description: >- + A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). + content: + application/json-patch+json: + schema: + type: array + items: + $ref: '../schemas/JsonPatchOperation.yaml' + examples: + Edit the source description: + description: This example shows how to edit a source description. + value: + [ + { + "op": "replace", + "path": "/description", + "value": "new description" + } + ] + Edit the source cluster: + description: This example shows how to edit a source cluster by ID. + value: + [ + { + "op": "replace", + "path": "/cluster/id", + "value": "2c918087813a902001813f3f85736b45" + } + ] + + Edit source features: + description: This example illustrates how you can update source supported features. + value: + [ + { + "op": "replace", + "path": "/features", + "value": [ + "PASSWORD", + "PROVISIONING", + "ENABLE", + "AUTHENTICATE" + ] + } + ] + Change a source description and cluster in one call: + description: This example shows how multiple fields may be updated with a single PATCH call. + value: + [ + { + "op": "replace", + "path": "/description", + "value": "new description" + }, + { + "op": "replace", + "path": "/cluster/id", + "value": "2c918087813a902001813f3f85736b45" + } + ] + Add a filter string to the connector: + description: This example shows how you can add a filter to incoming accounts during the account aggregation process. In the example, any account that does not have an "m" or "d" in the ID will be aggregated. + value: + [ + { + "op": "add", + "path": "/connectorAttributes/filterString", + "value": "!( id.contains( \"m\" ) ) || !( id.contains( \"d\" ) )" + } + ] + Update connector attribute for specific operation type: + description: This example shows how you can update the 3rd object in the connection parameter's `operationType`. This changes it from a standard group aggregation to a group aggregation on the "test" entitlement type. + value: + [ + { + "op": "replace", + "path": "/connectorAttributes/connectionParameters/2/operationType", + "value": "Group Aggregation-test" + } + ] + Enable notifications for new account provisioning on a source: + description: This example shows how you can configure and enable email notifications that will send when new accounts are provisioned on a source. + value: + [ + { + "op": "replace", + "path": "/connectorAttributes/accountCreateNotification", + "value": { + "notifyList": [ + "Distribution.list@demo.com" + ], + "notifyAccountOwner": true, + "enabled": true, + "notifyAccountOwnerAltEmail": false + } + } + ] + responses: + '200': + description: >- + Updated Source object. Any passwords will only show the the encrypted cipher-text so that they aren't decryptable + in Identity Security Cloud (ISC) cloud-based services, per ISC security design. + content: + application/json: + schema: + $ref: '../schemas/Source.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +delete: + operationId: deleteSource + security: + - userAuth: [ idn:sources:manage ] + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN + tags: + - Sources + summary: Delete Source by ID + description: >- + Use this API to delete a specific source in Identity Security Cloud (ISC). + + The API removes all the accounts on the source first, and then it deletes the source. + You can retrieve the actual task execution status with this method: GET `/task-status/{id}` + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSources + description: Source ID. + example: 2c9180835d191a86015d28455b4a2329 + responses: + '202': + description: Accepted - Returned if the request was successfully accepted into the system. + content: + application/json: + schema: + type: object + properties: + type: + description: Type of object being referenced. + type: string + enum: + - TASK_RESULT + example: TASK_RESULT + id: + type: string + description: Task result ID. + example: 2c91808779ecf55b0179f720942f181a + name: + type: string + description: Task result's human-readable display name (this should be null/empty). + example: null + examples: + deleteSource: + summary: Response returned when a source is being deleted. + value: {"type": "TASK_RESULT", "id": "2c91808779ecf55b0179f720942f181a", "name": null} + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + diff --git a/static/api-specs/idn/v2025/paths/sources-available.yaml b/static/api-specs/idn/v2025/paths/sources-available.yaml new file mode 100644 index 000000000..1378e4b93 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/sources-available.yaml @@ -0,0 +1,32 @@ +get: + operationId: listSources + tags: + - Sources + summary: List of filtered Sources + description: | + This end-point lists all sources with 'PASSWORD' feature, + sources assigned to the any of existing Password Sync Group are filtered out. + + responses: + '200': + description: Lists of 'PASSWORD' managed Sources, filtered out sources assigned to Password Sync Group. + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/SourceRef.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + security: + - userAuth: [idn:password-sync-group-management:read] \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/sources-entitlement-request-config.yaml b/static/api-specs/idn/v2025/paths/sources-entitlement-request-config.yaml new file mode 100644 index 000000000..1b9cda428 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/sources-entitlement-request-config.yaml @@ -0,0 +1,173 @@ +get: + security: + - userAuth: + - idn:sources:read + - idn:sources:manage + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN + operationId: getSourceEntitlementRequestConfig + summary: Get Source Entitlement Request Configuration + tags: + - Sources + description: >- + This API gets the current entitlement request configuration for a + source. This source-level configuration should apply for all the entitlements + in the source. + + + Access request to any entitlements in the source should follow this configuration + unless a separate entitlement-level configuration is defined. + + - During access request, this source-level entitlement request configuration overrides + the global organization-level configuration. + + - However, the entitlement-level configuration (if defined) overrides this source-level + configuration. + responses: + '200': + description: Source Entitlement Request Configuration Details. + content: + application/json: + schema: + $ref: ../schemas/SourceEntitlementRequestConfig.yaml + examples: + Get default config: + description: The default config for a source should look like the following + where the empty approvalSchemes indicates that no approvals are required. + value: + accessRequestConfig: + approvalSchemes: [] + requestCommentRequired: false + denialCommentRequired: false + Get config with one approval: + description: In case of a single approval, the config could look like + the following. + value: + accessRequestConfig: + approvalSchemes: + - approverId: null + approverType: SOURCE_OWNER + requestCommentRequired: true + denialCommentRequired: false + Get config with multiple approvals: + description: In case of multiple levels of approvals the config could + look like the following. In this scenario, access request review process + should go through all the approvers sequentially. + value: + accessRequestConfig: + approvalSchemes: + - approverId: null + approverType: ENTITLEMENT_OWNER + - approverId: null + approverType: SOURCE_OWNER + - approverId: 95e538a3-30c1-433a-af05-4bed973bbc22 + approverType: GOVERNANCE_GROUP + requestCommentRequired: true + denialCommentRequired: false + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true +put: + security: + - userAuth: + - idn:sources:manage + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN + operationId: updateSourceEntitlementRequestConfig + summary: Update Source Entitlement Request Configuration + tags: + - Sources + description: >- + This API replaces the current entitlement request configuration for + a source. This source-level configuration should apply for all the entitlements + in the source. + + + Access request to any entitlements in the source should follow this configuration + unless a separate entitlement-level configuration is defined. + + - During access request, this source-level entitlement request configuration overrides + the global organization-level configuration. + + - However, the entitlement-level configuration (if defined) overrides this source-level + configuration. + requestBody: + required: true + content: + application/json: + schema: + $ref: ../schemas/SourceEntitlementRequestConfig.yaml + examples: + Set config with no approvals: + description: If no approvals are required, the following config can be + set. + value: + accessRequestConfig: + approvalSchemes: [] + Set config with one approval: + description: In case of single approval the following config can be set. + value: + accessRequestConfig: + approvalSchemes: + - approverType: SOURCE_OWNER + requestCommentRequired: true + denialCommentRequired: false + Set config with multiple approvals: + description: In case of multiple levels of approvals the following config + can be set. In this scenario, access request review process should go + through all the approvers sequentially. + value: + accessRequestConfig: + approvalSchemes: + - approverType: ENTITLEMENT_OWNER + - approverType: SOURCE_OWNER + - approverType: GOVERNANCE_GROUP + approverId: 95e538a3-30c1-433a-af05-4bed973bbc22 + requestCommentRequired: true + denialCommentRequired: false + responses: + '200': + description: Source Entitlement Request Configuration Details. + content: + application/json: + schema: + $ref: ../schemas/SourceEntitlementRequestConfig.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true diff --git a/static/api-specs/idn/v2025/paths/sources-policy-holders.yaml b/static/api-specs/idn/v2025/paths/sources-policy-holders.yaml new file mode 100644 index 000000000..e3ead4177 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/sources-policy-holders.yaml @@ -0,0 +1,50 @@ +patch: + operationId: updatePasswordPolicyHolders + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN + - ROLE_SUBADMIN + tags: + - Sources + summary: Update Password Policy + description: | + This API can be used to set up or update Password Policy in IdentityNow for the specified Source. + Source must support PASSWORD feature. + parameters: + - in: path + name: sourceId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSources + description: The Source id + example: 8c190e6787aa4ed9a90bd9d5344523fb + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/PasswordPolicyHoldersDto.yaml' + responses: + '200': + description: >- + Updated Password Policies + content: + application/json: + schema: + $ref: '../schemas/PasswordPolicyHoldersDto.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + security: + - userAuth: [ idn:sources:update ] diff --git a/static/api-specs/idn/v2025/paths/sources.yaml b/static/api-specs/idn/v2025/paths/sources.yaml new file mode 100644 index 000000000..3c6b62954 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/sources.yaml @@ -0,0 +1,176 @@ +get: + operationId: listSources + security: + - userAuth: [idn:sources:read, idn:sources:manage] + - applicationAuth: [idn:sources:read, idn:sources:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN + - ROLE_SUBADMIN + tags: + - Sources + summary: Lists all sources in IdentityNow. + description: >- + This end-point lists all the sources in IdentityNow. + parameters: + - $ref: '../parameters/limit.yaml' + - $ref: '../parameters/offset.yaml' + - $ref: '../parameters/count.yaml' + - in: query + name: filters + schema: + type: string + example: name eq "Employees" + description: >- + Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) + + + Filtering is supported for the following fields and operators: + + + **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* + + + **name**: *co, eq, in, sw, ge, gt, ne, isnull* + + + **type**: *eq, in, ge, gt, ne, isnull, sw* + + + **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* + + + **features**: *ca, co* + + + **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* + + + **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* + + + **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* + + + **description**: *eq, sw* + + + **authoritative**: *eq, ne, isnull* + + + **healthy**: *isnull* + + + **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* + + + **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* + + + **connectorName**: *eq, ge, gt, in, ne, isnull, sw* + + + **category**: *co, eq, ge, gt, in, le, lt, ne, sw* + - in: query + name: sorters + schema: + type: string + format: comma-separated + example: name + description: >- + Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** + - in: query + name: for-subadmin + schema: + type: string + example: name + description: >- + Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity + with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. + + Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when + this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this + parameter, a 403 Forbidden is returned. + - in: query + name: includeIDNSource + required: false + schema: + type: boolean + default: false + example: true + description: Include the IdentityNow source in the response. + responses: + '200': + description: List of Source objects + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/Source.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +post: + operationId: createSource + security: + - userAuth: [ idn:sources:manage ] + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN + tags: + - Sources + summary: Creates a source in IdentityNow. + description: >- + This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and + encrypted upon receipt in IdentityNow. + parameters: + - in: query + name: provisionAsCsv + description: >- + If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. + You must use this query parameter to create a Delimited File source as you would in the UI. + If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. + schema: + type: boolean + required: false + example: false + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/Source.yaml' + responses: + '201': + description: >- + Created Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able + in IdentityNow cloud-based services, per IdentityNow security design. + content: + application/json: + schema: + $ref: '../schemas/Source.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/sp-config-export-download.yaml b/static/api-specs/idn/v2025/paths/sp-config-export-download.yaml new file mode 100644 index 000000000..bd311ecc9 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/sp-config-export-download.yaml @@ -0,0 +1,43 @@ +get: + operationId: getSpConfigExport + security: + - userAuth: [sp:config:read, sp:config:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + tags: + - SP-Config + summary: Download export job result. + description: 'This endpoint gets the export file resulting from the export job with + the requested `id` and downloads it to a file. + + The request will need one of the following security scopes: + + - sp:config:read - sp:config:manage' + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: exportSpConfig + description: The ID of the export job whose results will be downloaded. + example: ef38f94347e94562b5bb8424a56397d8 + responses: + '200': + description: Exported JSON objects. + content: + application/json: + schema: + $ref: ../schemas/SpConfigExportResults.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/sp-config-export-status.yaml b/static/api-specs/idn/v2025/paths/sp-config-export-status.yaml new file mode 100644 index 000000000..e8928d864 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/sp-config-export-status.yaml @@ -0,0 +1,52 @@ +get: + operationId: getSpConfigExportStatus + security: + - userAuth: [sp:config:read, sp:config:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + tags: + - SP-Config + summary: Get export job status + description: 'This gets the status of the export job identified by the `id` parameter. + + The request will need one of the following security scopes: + + - sp:config:read - sp:config:manage' + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: exportSpConfig + description: The ID of the export job whose status will be returned. + example: ef38f94347e94562b5bb8424a56397d8 + responses: + '200': + description: Export job status successfully returned. + content: + application/json: + schema: + $ref: ../schemas/SpConfigExportJobStatus.yaml + example: + jobId: 1e824aa0-4c6e-4f14-95e9-e7dc5234aa51 + status: COMPLETE + type: EXPORT + message: null + description: Export Job 1 Test + expiration: '2021-05-20T15:04:24Z' + created: '2021-05-13T15:04:24.112Z' + modified: '2021-05-13T15:04:27.363Z' + completed: '2021-05-13T15:04:27.358Z' + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/sp-config-export.yaml b/static/api-specs/idn/v2025/paths/sp-config-export.yaml new file mode 100644 index 000000000..3903edcee --- /dev/null +++ b/static/api-specs/idn/v2025/paths/sp-config-export.yaml @@ -0,0 +1,130 @@ +post: + operationId: exportSpConfig + security: + - userAuth: [sp:config:read, sp:config:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + tags: + - SP-Config + summary: Initiates configuration objects export job + description: 'This post will export objects from the tenant to a JSON configuration + file. + + For more information about the object types that currently support export functionality, + refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).' + requestBody: + description: Export options control what will be included in the export. + required: true + content: + application/json: + schema: + $ref: ../schemas/ExportPayload.yaml + examples: + Export all objects available: + description: Export all object types available in IDN. + value: + description: Export all available objects + excludeTypes: [] + includeTypes: + - ACCESS_PROFILE + - ACCESS_REQUEST_CONFIG + - ATTR_SYNC_SOURCE_CONFIG + - AUTH_ORG + - CAMPAIGN_FILTER + - CONNECTOR_RULE + - FORM_DEFINITION + - GOVERNANCE_GROUP + - IDENTITY_OBJECT_CONFIG + - IDENTITY_PROFILE + - LIFECYCLE_STATE + - NOTIFICATION_TEMPLATE + - PASSWORD_POLICY + - PASSWORD_SYNC_GROUP + - PUBLIC_IDENTITIES_CONFIG + - ROLE + - RULE + - SEGMENT + - SERVICE_DESK_INTEGRATION + - SOD_POLICY + - SOURCE + - TAG + - TRANSFORM + - TRIGGER_SUBSCRIPTION + - WORKFLOW + objectOptions: {} + Export sources by ID: + description: Export only sources that match the IDs specified in the export + options. + value: + description: Export sources by ID + excludeTypes: [] + includeTypes: + - SOURCE + objectOptions: + SOURCE: + includedIds: + - be9e116d-08e1-49fc-ab7f-fa585e96c9e4 + - be9p119e-90e1-49pk-ac9f-fa576e96c9e4 + includedNames: [] + Export transforms by name: + description: Export only transforms that match the names specified in + the export options. + value: + description: Export transforms by name + excludeTypes: [] + includeTypes: + - TRANSFORM + objectOptions: + TRANSFORM: + includedIds: [] + includedNames: + - Remove Diacritical Marks + - Common - Location Lookup + Export trigger subscriptions triggers and transforms with custom options: + description: Export trigger subscriptions and transforms that match the + export options. + value: + description: Export trigger subscriptions and transforms with custom + filter options + excludeTypes: [] + includeTypes: + - TRANSFORM + - TRIGGER_SUBSCRIPTION + objectOptions: + TRANSFORM: + includedIds: [] + includedNames: + - Remove Diacritical Marks + - Common - Location Lookup + TRIGGER_SUBSCRIPTION: + includedIds: + - be9e116d-08e1-49fc-ab7f-fa585e96c9e4 + - be9p119e-90e1-49pk-ac9f-fa576e96c9e4 + includedNames: + - 'NGROK Test: fire and forget' + - Manager Certification + responses: + '202': + description: Export job accepted and queued for processing. + content: + application/json: + schema: + $ref: ../schemas/SpConfigExportJob.yaml + '400': + description: 'Client Error - Returned if the request body is invalid. + + ' + content: + application/json: + schema: + $ref: ../schemas/ErrorResponseDto.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/sp-config-import-download.yaml b/static/api-specs/idn/v2025/paths/sp-config-import-download.yaml new file mode 100644 index 000000000..edf56f20c --- /dev/null +++ b/static/api-specs/idn/v2025/paths/sp-config-import-download.yaml @@ -0,0 +1,46 @@ +get: + operationId: getSpConfigImport + security: + - userAuth: [sp:config:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + tags: + - SP-Config + summary: Download import job result + description: 'This gets import file resulting from the import job with the requested + id and downloads it to a file. The downloaded file will contain the results of + the import operation, including any error, warning or informational messages associated + with the import. + + The request will need the following security scope: + + - sp:config:manage' + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: importSpConfig + description: The ID of the import job whose results will be downloaded. + example: ef38f94347e94562b5bb8424a56397d8 + responses: + '200': + description: Import results JSON object, containing detailed results of the + import operation. + content: + application/json: + schema: + $ref: ../schemas/SpConfigImportResults.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/sp-config-import-status.yaml b/static/api-specs/idn/v2025/paths/sp-config-import-status.yaml new file mode 100644 index 000000000..ab84da013 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/sp-config-import-status.yaml @@ -0,0 +1,52 @@ +get: + operationId: getSpConfigImportStatus + security: + - userAuth: [sp:config:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + tags: + - SP-Config + summary: Get import job status + description: | + 'This gets the status of the import job identified by the `id` parameter. + + For more information about the object types that currently support import functionality, + refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).' + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: importSpConfig + description: The ID of the import job whose status will be returned. + example: ef38f94347e94562b5bb8424a56397d8 + responses: + '200': + description: Import job status successfully returned. + content: + application/json: + schema: + $ref: ../schemas/SpConfigImportJobStatus.yaml + example: + jobId: 4fb10503-1c49-4603-8f8d-886e1f6aa47b + status: COMPLETE + type: IMPORT + message: Download import results for details. + description: null + expiration: '2021-05-20T16:42:39Z' + created: '2021-05-13T16:42:39.333Z' + modified: '2021-05-13T16:42:40.71Z' + completed: '2021-05-13T16:42:40.705Z' + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/sp-config-import.yaml b/static/api-specs/idn/v2025/paths/sp-config-import.yaml new file mode 100644 index 000000000..aab7fc420 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/sp-config-import.yaml @@ -0,0 +1,154 @@ +post: + operationId: importSpConfig + security: + - userAuth: [sp:config:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + tags: + - SP-Config + summary: Initiates configuration objects import job + description: | + This post will import objects from a JSON configuration file into a tenant. + By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. + The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. + The backup can be skipped by setting "excludeBackup" to true in the import options. + If a backup is performed, the id of the backup will be provided in the ImportResult as the "exportJobId". This can be downloaded + using the `/sp-config/export/{exportJobId}/download` endpoint. + + You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. + + For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects). + parameters: + - in: query + name: preview + schema: + type: boolean + default: false + required: false + description: | + This option is intended to give the user information about how an + import operation would proceed, without having any effect on the target tenant. + If this parameter is "true", no objects will be imported. Instead, the import + process will pre-process the import file and attempt to resolve references within + imported objects. The import result file will contain messages pertaining to + how specific references were resolved, any errors associated with the preprocessing, + and messages indicating which objects would be imported. + example: 'true' + requestBody: + description: | + The form-data "name" attribute for the file content must be "data". + + __Example__ + + data: "config_export_0340b957-5caa-44f6-ada2-d3c4c5bd0b19.json", + options: { + "excludeTypes": [], + "includeTypes": ["TRIGGER_SUBSCRIPTION"], + "objectOptions": { + "TRIGGER_SUBSCRIPTION": { + "includedIds": [ "193446a1-c431-4326-8ba7-d6eebf922948"], + "includedNames":[] + } + }, + "defaultReferences": [ + { + "type": "TRIGGER_SUBSCRIPTION", + "id": "be9e116d-08e1-49fc-ab7f-fa585e96c9e4", + "name": "Test Trigger" + } + ], + "excludeBackup": false + } + + __Sample Import File__ + + { + "version": 1, + "timestamp": "2021-05-10T15:19:23.425041-05:00", + "tenant": "sampleTenant", + "options": { + "excludeTypes": [], + "includeTypes": ["TRIGGER_SUBSCRIPTION"], + "objectOptions": null + }, + "objects": [{ + "version": 1, + "self": { + "type": "TRIGGER_SUBSCRIPTION", + "name": "test trigger", + "id": "193446a1-c431-4326-8ba7-d6eebf922948" + }, + "object": { + "type": "HTTP", + "enabled": true, + "httpConfig": { + "url": "https://localhost", + "httpAuthenticationType": "NO_AUTH", + "basicAuthConfig": null, + "bearerTokenAuthConfig": null, + "httpDispatchMode": "SYNC" + }, + "triggerName": "Access Request Submitted", + "responseDeadline": "PT1H", + "name": "test trigger", + "triggerId": "idn:access-request-pre-approval" + } + } + ] + } + required: true + content: + multipart/form-data: + schema: + type: object + properties: + data: + type: string + format: binary + description: JSON file containing the objects to be imported. + options: + $ref: ../schemas/ImportOptions.yaml + required: + - data + example: + data: config_export_0340b957-5caa-44f6-ada2-d3c4c5bd0b19.json + options: + excludeTypes: [] + includeTypes: + - TRIGGER_SUBSCRIPTION + objectOptions: + TRIGGER_SUBSCRIPTION: + includedIds: + - be9e116d-08e1-49fc-ab7f-fa585e96c9e4 + includedNames: + - Lori Test 2 + defaultReferences: + - type: TRIGGER_SUBSCRIPTION + id: be9e116d-08e1-49fc-ab7f-fa585e96c9e4 + name: Test Trigger + excludeBackup: false + responses: + '202': + description: Import job accepted and queued for processing. + content: + application/json: + schema: + $ref: ../schemas/SpConfigJob.yaml + '400': + description: 'Client Error - Returned if the request body is invalid. + + ' + content: + application/json: + schema: + $ref: ../schemas/ErrorResponseDto.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/sp-config-objects.yaml b/static/api-specs/idn/v2025/paths/sp-config-objects.yaml new file mode 100644 index 000000000..47b0253e7 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/sp-config-objects.yaml @@ -0,0 +1,33 @@ +get: + operationId: listSpConfigObjects + security: + - userAuth: [sp:config:read, sp:config:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + tags: + - SP-Config + summary: Get config object details + description: This gets the list of object configurations which are known to the + tenant export/import service. Object configurations that contain "importUrl" and + "exportUrl" are available for export/import. + responses: + '200': + description: Object configurations returned successfully. + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/SpConfigObject.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/suggested-entitlement-description-approvals.yaml b/static/api-specs/idn/v2025/paths/suggested-entitlement-description-approvals.yaml new file mode 100644 index 000000000..bd2866cdb --- /dev/null +++ b/static/api-specs/idn/v2025/paths/suggested-entitlement-description-approvals.yaml @@ -0,0 +1,44 @@ +post: + tags: + - Suggested Entitlement Description + summary: Submit Bulk Approval Request + description: 'Submit Bulk Approval Request for SED. + + Request body takes list of SED Ids. API responses with list of SED Approval Status' + operationId: submitSedApproval + requestBody: + description: Sed Approval + content: + application/json-patch+json: + schema: + items: + $ref: ../schemas/SedApproval.yaml + type: array + required: true + responses: + '200': + description: List of SED Approval Status + content: + application/json: + schema: + items: + $ref: ../schemas/SedApprovalStatus.yaml + type: array + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: + - idn:sed:write + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN diff --git a/static/api-specs/idn/v2025/paths/suggested-entitlement-description-assignments.yaml b/static/api-specs/idn/v2025/paths/suggested-entitlement-description-assignments.yaml new file mode 100644 index 000000000..0b03c9773 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/suggested-entitlement-description-assignments.yaml @@ -0,0 +1,41 @@ +post: + tags: + - Suggested Entitlement Description + operationId: submitSedAssignment + summary: Submit Sed Assignment Request + description: 'Submit Assignment Request. + + Request body has an assignee, and list of SED Ids that are assigned to that assignee + API responses with batchId that groups all approval requests together' + requestBody: + description: Sed Assignment Request + content: + application/json-patch+json: + schema: + $ref: ../schemas/SedAssignment.yaml + required: true + responses: + '202': + description: Sed Assignment Response + content: + application/json: + schema: + $ref: ../schemas/SedAssignmentResponse.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: + - idn:sed:write + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN diff --git a/static/api-specs/idn/v2025/paths/suggested-entitlement-description-batches-stats.yaml b/static/api-specs/idn/v2025/paths/suggested-entitlement-description-batches-stats.yaml new file mode 100644 index 000000000..9e77055f0 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/suggested-entitlement-description-batches-stats.yaml @@ -0,0 +1,45 @@ +get: + tags: + - Suggested Entitlement Description + operationId: getSedBatchStats + summary: Submit Sed Batch Stats Request + description: | + 'Submit Sed Batch Stats Request. + + Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats + of the batchId.' + parameters: + - name: batchId + in: path + description: Batch Id + schema: + type: string + format: uuid + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb + required: true + x-sailpoint-resource-operation-id: getSedBatches + responses: + '200': + description: Stats of Sed batch. + content: + application/json: + schema: + $ref: ../schemas/SedBatchStats.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: + - idn:sed:read + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN diff --git a/static/api-specs/idn/v2025/paths/suggested-entitlement-description-batches.yaml b/static/api-specs/idn/v2025/paths/suggested-entitlement-description-batches.yaml new file mode 100644 index 000000000..828ab84ae --- /dev/null +++ b/static/api-specs/idn/v2025/paths/suggested-entitlement-description-batches.yaml @@ -0,0 +1,76 @@ +get: + tags: + - Suggested Entitlement Description + operationId: getSedBatches + summary: List Sed Batch Request + description: 'List Sed Batches. + + API responses with Sed Batch Status' + responses: + '200': + description: Status of batch + content: + application/json: + schema: + $ref: ../schemas/SedBatchStatus.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: + - idn:sed:read + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN +post: + tags: + - Suggested Entitlement Description + operationId: submitSedBatchRequest + summary: Submit Sed Batch Request + description: 'Submit Sed Batch Request. + + Request body has one of the following: + - a list of entitlement Ids + - a list of SED Ids + that user wants to have description generated by LLM. + API responses with batchId that groups Ids together' + requestBody: + description: Sed Batch Request + content: + application/json-patch+json: + schema: + $ref: ../schemas/SedBatchRequest.yaml + responses: + '200': + description: Sed Batch Response + content: + application/json: + schema: + $ref: ../schemas/SedBatchResponse.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: + - idn:sed:write + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN diff --git a/static/api-specs/idn/v2025/paths/suggested-entitlement-descriptions.yaml b/static/api-specs/idn/v2025/paths/suggested-entitlement-descriptions.yaml new file mode 100644 index 000000000..a06b6f380 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/suggested-entitlement-descriptions.yaml @@ -0,0 +1,183 @@ +get: + tags: + - Suggested Entitlement Description + operationId: listSeds + summary: List Suggested Entitlement Descriptions + description: 'List of Suggested Entitlement Descriptions (SED) + + + SED field descriptions: + + + **batchId**: the ID of the batch of entitlements that are submitted for description generation + + + **displayName**: the display name of the entitlement that we are generating a description for + + + **sourceName**: the name of the source associated with the entitlement that we are generating the description for + + + **sourceId**: the ID of the source associated with the entitlement that we are generating the description for + + + **status**: the status of the suggested entitlement description, valid status options: "requested", "suggested", "not_suggested", "failed", "assigned", "approved", "denied" + + + **fullText**: will filter suggested entitlement description records by text found in any of the following fields: entitlement name, entitlement display name, suggested description, source name' + parameters: + - $ref: ../parameters/limit.yaml + - $ref: ../parameters/offset.yaml + - $ref: ../parameters/count.yaml + - description: >- + 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: + + + **batchId**: *eq, ne* + + + **displayName**: *eq, ne, co* + + + **sourceName**: *eq, ne, co* + + + **sourceId**: *eq, ne* + + + **status**: *eq, ne* + + + **fullText**: *co* + + in: query + name: filters + example: displayName co "Read and Write" + required: false + schema: + type: string + - description: >- + Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **displayName, sourceName, status** + in: query + name: sorters + required: false + example: sorters=displayName + schema: + type: string + - description: '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. + + This parameter differs from the count parameter in that this one skips executing + the actual query and always return an empty array.' + in: query + name: count-only + required: false + example: count-only=true + schema: + type: boolean + default: false + - description: "By default, the ListSeds API will only return items that you have\ + \ requested to be generated. \nThis option will allow you to see all items\ + \ that have been requested" + in: query + name: requested-by-anyone + example: requested-by-anyone=true + required: false + schema: + type: boolean + default: false + - description: Will limit records to items that are in "suggested" or "approved" + status + in: query + name: show-pending-status-only + example: show-pending-status-only=true + required: false + schema: + type: boolean + default: false + responses: + '200': + description: List of Suggested Entitlement Details + content: + application/json: + schema: + items: + $ref: ../schemas/Sed.yaml + type: array + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: + - 'idn:sed:read' + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN + +patch: + tags: + - Suggested Entitlement Description + operationId: patchSed + summary: Patch Suggested Entitlement Description + description: Patch Suggested Entitlement Description + parameters: + - description: id is sed id + in: path + name: id + example: ebab396f-0af1-4050-89b7-dafc63ec70e7 + required: true + x-sailpoint-resource-operation-id: listSeds + schema: + type: string + format: uuid + requestBody: + description: Sed Patch Request + content: + application/json-patch+json: + schema: + items: + $ref: ../schemas/SedPatch.yaml + type: array + required: true + responses: + '200': + description: detail of patched sed + content: + application/json: + schema: + $ref: ../schemas/Sed.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: + - 'idn:sed:write' + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN diff --git a/static/api-specs/idn/v2025/paths/supportlogin/access-granter-support-login-get.yaml b/static/api-specs/idn/v2025/paths/supportlogin/access-granter-support-login-get.yaml new file mode 100644 index 000000000..a02f81228 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/supportlogin/access-granter-support-login-get.yaml @@ -0,0 +1,38 @@ +get: + operationId: accessGranterSupportLoginGet + tags: + - Auth Support Login + summary: Get an access granter support login record by granter tenant + description: >- + Fetch the auth support login record associated with the tenant requesting + support (i.e., the tenant requesting support). To be invoked by the + authTenant. + + Request will require the following security scope: + **sp:auth-support-login:read** + parameters: + - in: path + name: accessGranterTenant + description: >- + The tenant in need of support. + required: true + schema: + type: string + + responses: + "200": + description: access granter support login response. + content: + application/json: + schema: + $ref: "../../schemas/AccessGranterAuthSupportLoginResponse.yaml" + "400": + $ref: "../../responses/400.yaml" + "401": + $ref: "../../responses/401.yaml" + "403": + $ref: "../../responses/403.yaml" + "404": + $ref: "../../responses/404.yaml" + "500": + $ref: "../../responses/500.yaml" diff --git a/static/api-specs/idn/v2025/paths/supportlogin/access-granter-support-login-list.yaml b/static/api-specs/idn/v2025/paths/supportlogin/access-granter-support-login-list.yaml new file mode 100644 index 000000000..50205f007 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/supportlogin/access-granter-support-login-list.yaml @@ -0,0 +1,55 @@ +get: + operationId: accessGranterSupportLoginList + tags: + - Auth Support Login + summary: List access granter support login records + description: >- + Fetch the list of auth support login records that grant access to the auth + tenant (i.e., the tenant providing support). To be invoked by the + authTenant. Request will require the following security scope: + **sp:auth-support-login:read** + parameters: + - $ref: "../../parameters/limit.yaml" + - $ref: "../../parameters/offset.yaml" + - $ref: "../../parameters/count.yaml" + - in: query + name: sorters + schema: + type: string + format: comma-separated + description: >- + Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **accessGranterTenant, authUserName, role, expirationDate** + example: accessGranterTenant + - in: query + name: filters + schema: + type: string + description: >- + 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: + + + **accessGranterTenant**: *eq, co, sw* + example: accessGranterTenant co "solar" + responses: + "200": + description: list of access granter support login responses. + content: + application/json: + schema: + type: array + items: + $ref: "../../schemas/AccessGranterAuthSupportLoginResponse.yaml" + "400": + $ref: "../../responses/400.yaml" + "401": + $ref: "../../responses/401.yaml" + "403": + $ref: "../../responses/403.yaml" + "500": + $ref: "../../responses/500.yaml" diff --git a/static/api-specs/idn/v2025/paths/supportlogin/auth-support-login-create.yaml b/static/api-specs/idn/v2025/paths/supportlogin/auth-support-login-create.yaml new file mode 100644 index 000000000..eb9bea6c9 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/supportlogin/auth-support-login-create.yaml @@ -0,0 +1,35 @@ +operationId: authSupportLoginCreation +tags: + - Auth Support Login +summary: Create auth support login record +description: >- + This request will create an auth support login record allowing the authTenant + to be able to login as a support user into the tenant requesting support. + + Request will require the following security scope: + **sp:auth-support-login:create** + +requestBody: + description: Auth support login creation request body. + required: true + content: + application/json: + schema: + $ref: "../../schemas/AuthSupportLoginRequest.yaml" +responses: + "200": + description: Created auth support login record. + content: + application/json: + schema: + $ref: "../../schemas/AuthSupportLoginResponse.yaml" + "400": + $ref: "../../responses/400.yaml" + "401": + $ref: "../../responses/401.yaml" + "403": + $ref: "../../responses/403.yaml" + "429": + $ref: "../../responses/429.yaml" + "500": + $ref: "../../responses/500.yaml" diff --git a/static/api-specs/idn/v2025/paths/supportlogin/auth-support-login-delete.yaml b/static/api-specs/idn/v2025/paths/supportlogin/auth-support-login-delete.yaml new file mode 100644 index 000000000..51617eec9 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/supportlogin/auth-support-login-delete.yaml @@ -0,0 +1,28 @@ +operationId: authSupportLoginDelete +tags: + - Auth Support Login +summary: Delete auth support login record by auth tenant +description: >- + This request will delete an auth support login record. Request will require + the following security scope: **sp:auth-support-login:delete** +parameters: + - in: path + name: authTenant + description: >- + The tenant providing support. + required: true + schema: + type: string +responses: + "204": + $ref: "../../responses/204.yaml" + "400": + $ref: "../../responses/400.yaml" + "401": + $ref: "../../responses/401.yaml" + "403": + $ref: "../../responses/403.yaml" + "404": + $ref: "../../responses/404.yaml" + "500": + $ref: "../../responses/500.yaml" diff --git a/static/api-specs/idn/v2025/paths/supportlogin/auth-support-login-get.yaml b/static/api-specs/idn/v2025/paths/supportlogin/auth-support-login-get.yaml new file mode 100644 index 000000000..e12b5897b --- /dev/null +++ b/static/api-specs/idn/v2025/paths/supportlogin/auth-support-login-get.yaml @@ -0,0 +1,35 @@ +operationId: authSupportLoginGet +tags: + - Auth Support Login +summary: Get auth support login record by auth tenant +description: >- + Fetch an auth support login record by an authorized auth tenant. + + Request will require the following security scope: + **sp:auth-support-login:read** + +parameters: + - in: path + name: authTenant + description: >- + The tenant providing support. + required: true + schema: + type: string +responses: + "200": + description: auth support login response. + content: + application/json: + schema: + $ref: "../../schemas/AuthSupportLoginResponse.yaml" + "400": + $ref: "../../responses/400.yaml" + "401": + $ref: "../../responses/401.yaml" + "403": + $ref: "../../responses/403.yaml" + "404": + $ref: "../../responses/404.yaml" + "500": + $ref: "../../responses/500.yaml" diff --git a/static/api-specs/idn/v2025/paths/supportlogin/auth-support-login-list.yaml b/static/api-specs/idn/v2025/paths/supportlogin/auth-support-login-list.yaml new file mode 100644 index 000000000..1b98ac22e --- /dev/null +++ b/static/api-specs/idn/v2025/paths/supportlogin/auth-support-login-list.yaml @@ -0,0 +1,53 @@ +operationId: authSupportLoginList +tags: + - Auth Support Login +summary: List auth support login records +description: >- + Fetch list of auth support login records that the tenant has granted access + to. Request will require the following security scope: + **sp:auth-support-login:read** +parameters: + - $ref: "../../parameters/limit.yaml" + - $ref: "../../parameters/offset.yaml" + - $ref: "../../parameters/count.yaml" + - in: query + name: sorters + schema: + type: string + format: comma-separated + description: >- + Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **authTenant, authUserName, role, expirationDate** + example: authTenant + - in: query + name: filters + schema: + type: string + description: >- + 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: + + + **authTenant**: *eq, sw* + example: authTenant eq "sailpoint" +responses: + "200": + description: list of auth support login responses. + content: + application/json: + schema: + type: array + items: + $ref: "../../schemas/AuthSupportLoginResponse.yaml" + "400": + $ref: "../../responses/400.yaml" + "401": + $ref: "../../responses/401.yaml" + "403": + $ref: "../../responses/403.yaml" + "500": + $ref: "../../responses/500.yaml" diff --git a/static/api-specs/idn/v2025/paths/supportlogin/auth-support-login-patch.yaml b/static/api-specs/idn/v2025/paths/supportlogin/auth-support-login-patch.yaml new file mode 100644 index 000000000..08504591a --- /dev/null +++ b/static/api-specs/idn/v2025/paths/supportlogin/auth-support-login-patch.yaml @@ -0,0 +1,48 @@ +operationId: authSupportLoginPatch +tags: + - Auth Support Login +summary: Patch auth support login record by auth tenant +description: >- + This request will patch an auth support login record. Patchable fields: + **expirationDate** Request will require the following security + scope: **sp:auth-support-login:update** +parameters: + - in: path + name: authTenant + description: >- + The tenant providing support. + required: true + schema: + type: string +requestBody: + description: + A list of auth support login update operations according to the [JSON + Patch](https://tools.ietf.org/html/rfc6902) standard. + required: true + content: + application/json-patch+json: + schema: + type: array + items: + $ref: "../../schemas/JsonPatchOperation.yaml" + example: + - op: "replace" + path: "/expirationDate" + value: "2030-08-23T18:00:00.000Z" +responses: + "200": + description: Updated auth support login record. + content: + application/json: + schema: + $ref: "../../schemas/AuthSupportLoginResponse.yaml" + "400": + $ref: "../../responses/400.yaml" + "401": + $ref: "../../responses/401.yaml" + "403": + $ref: "../../responses/403.yaml" + "404": + $ref: "../../responses/404.yaml" + "500": + $ref: "../../responses/500.yaml" diff --git a/static/api-specs/idn/v2025/paths/supportlogin/auth-support-login-transfer-get.yaml b/static/api-specs/idn/v2025/paths/supportlogin/auth-support-login-transfer-get.yaml new file mode 100644 index 000000000..0d307867a --- /dev/null +++ b/static/api-specs/idn/v2025/paths/supportlogin/auth-support-login-transfer-get.yaml @@ -0,0 +1,37 @@ +operationId: authSupportTransferStatusGet +tags: + - Auth Support Login +summary: Get auth support transfer status record by tenant +description: >- + Fetches an auth support transfer status record by tenant. + + This request requires the following security scope: + **sp:auth-support-login-transfer:read** +parameters: + - in: path + name: tenant + description: >- + The name of org granting access to Support and Services + required: true + schema: + type: string +responses: + "200": + description: + Response containing the name of the tenant associated with an auth support + login access grant and an indication whether that tenant has been + transferred yet. + content: + application/json: + schema: + $ref: "../../schemas/AuthSupportTransferStatusResponse.yaml" + "400": + $ref: "../../responses/400.yaml" + "401": + $ref: "../../responses/401.yaml" + "403": + $ref: "../../responses/403.yaml" + "404": + $ref: "../../responses/404.yaml" + "500": + $ref: "../../responses/500.yaml" diff --git a/static/api-specs/idn/v2025/paths/supportlogin/auth-support-login-transfer-post.yaml b/static/api-specs/idn/v2025/paths/supportlogin/auth-support-login-transfer-post.yaml new file mode 100644 index 000000000..e97516db5 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/supportlogin/auth-support-login-transfer-post.yaml @@ -0,0 +1,41 @@ +operationId: authSupportLoginTransfer +tags: + - Auth Support Login +summary: Transfer auth support login grant +description: >- + Transfers an auth support login access grant for the specified tenant by + setting the transferred field in the tenant's auth support transfer status + record to "true" and deleting the tenant's initial auth support login record. + + This request requires the following security scope: + **sp:auth-support-login-transfer:update** +parameters: + - in: path + name: tenant + description: >- + The name of org granting access to Support and Services + required: true + schema: + type: string +responses: + "200": + description: + Response containing the name of the tenant associated with an auth support + login access grant and an indication whether that tenant has been + transferred yet. + content: + application/json: + schema: + $ref: "../../schemas/AuthSupportTransferStatusResponse.yaml" + "400": + $ref: "../../responses/400.yaml" + "401": + $ref: "../../responses/401.yaml" + "403": + $ref: "../../responses/403.yaml" + "404": + $ref: "../../responses/404.yaml" + "429": + $ref: "../../responses/429.yaml" + "500": + $ref: "../../responses/500.yaml" diff --git a/static/api-specs/idn/v2025/paths/supportlogin/auth-support-login-transfer.yaml b/static/api-specs/idn/v2025/paths/supportlogin/auth-support-login-transfer.yaml new file mode 100644 index 000000000..02f7b4347 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/supportlogin/auth-support-login-transfer.yaml @@ -0,0 +1,4 @@ +get: + $ref: './auth-support-login-transfer-get.yaml' +post: + $ref: './auth-support-login-transfer-post.yaml' diff --git a/static/api-specs/idn/v2025/paths/supportlogin/auth-support-login-transfers-list.yaml b/static/api-specs/idn/v2025/paths/supportlogin/auth-support-login-transfers-list.yaml new file mode 100644 index 000000000..f23518d94 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/supportlogin/auth-support-login-transfers-list.yaml @@ -0,0 +1,54 @@ +get: + operationId: authSupportTransferStatusList + tags: + - Auth Support Login + summary: List auth support transfer status records + description: >- + Fetches a list of auth support transfer status records that indicate whether + an auth support login has been transferred. This request requires the + following security scope: **sp:auth-support-login-transfer:read** + parameters: + - $ref: "../../parameters/limit.yaml" + - $ref: "../../parameters/offset.yaml" + - $ref: "../../parameters/count.yaml" + - in: query + name: sorters + schema: + type: string + format: comma-separated + description: >- + Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **tenant** + example: tenant + - in: query + name: filters + schema: + type: string + description: >- + 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: + + + **transferred**: *eq* + example: transferred eq false + responses: + "200": + description: list of auth support transfer status responses. + content: + application/json: + schema: + type: array + items: + $ref: "../../schemas/AuthSupportTransferStatusResponse.yaml" + "400": + $ref: "../../responses/400.yaml" + "401": + $ref: "../../responses/401.yaml" + "403": + $ref: "../../responses/403.yaml" + "500": + $ref: "../../responses/500.yaml" diff --git a/static/api-specs/idn/v2025/paths/supportlogin/auth-support-login.yaml b/static/api-specs/idn/v2025/paths/supportlogin/auth-support-login.yaml new file mode 100644 index 000000000..5ce747740 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/supportlogin/auth-support-login.yaml @@ -0,0 +1,6 @@ +get: + $ref: './auth-support-login-get.yaml' +patch: + $ref: './auth-support-login-patch.yaml' +delete: + $ref: './auth-support-login-delete.yaml' diff --git a/static/api-specs/idn/v2025/paths/supportlogin/auth-support-logins-migrate.yaml b/static/api-specs/idn/v2025/paths/supportlogin/auth-support-logins-migrate.yaml new file mode 100644 index 000000000..6f1355627 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/supportlogin/auth-support-logins-migrate.yaml @@ -0,0 +1,40 @@ +post: + operationId: authSupportLoginsMigrate + tags: + - Auth Support Login + summary: Migrate auth support login records + description: >- + Migrates all the auth support login access grants from the specified auth + tenant to the new auth tenant in the request context, resulting in the new + auth tenant having possession of all the old auth tenant's auth support + login access grants and the old auth tenant no longer having any more auth + support login access grants. + + Because this is a highly privileged operation meant only to be executable by + SailPoint DevOps, this request requires the following security scope: + **sp:auth-support-login-transfer:update** + parameters: + - in: path + name: oldAuthTenant + description: >- + The name of auth tenant whose auth support login access grants will be + migrated to the calling auth tenant + example: acme-solar + required: true + schema: + type: string + responses: + "202": + $ref: "../../responses/202.yaml" + "400": + $ref: "../../responses/400.yaml" + "401": + $ref: "../../responses/401.yaml" + "403": + $ref: "../../responses/403.yaml" + "404": + $ref: "../../responses/404.yaml" + "429": + $ref: "../../responses/429.yaml" + "500": + $ref: "../../responses/500.yaml" diff --git a/static/api-specs/idn/v2025/paths/supportlogin/auth-support-logins.yaml b/static/api-specs/idn/v2025/paths/supportlogin/auth-support-logins.yaml new file mode 100644 index 000000000..bdacea632 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/supportlogin/auth-support-logins.yaml @@ -0,0 +1,4 @@ +get: + $ref: './auth-support-login-list.yaml' +post: + $ref: './auth-support-login-create.yaml' diff --git a/static/api-specs/idn/v2025/paths/supportlogin/auth-support-tenant-create.yaml b/static/api-specs/idn/v2025/paths/supportlogin/auth-support-tenant-create.yaml new file mode 100644 index 000000000..e5b087c9d --- /dev/null +++ b/static/api-specs/idn/v2025/paths/supportlogin/auth-support-tenant-create.yaml @@ -0,0 +1,40 @@ +operationId: authSupportTenantCreate +tags: + - Auth Support Login +summary: Create auth support tenant record +description: >- + This request will create an auth support tenant record for the tenant making + the call, making that tenant the auth tenant in the new record. This new + record will function as a prerequisite metadata reference for when a target + tenant attempts to create an auth support login record that grants access to a + particular auth tenant. Thus, a target tenant must name an auth tenant that + exists within an auth support tenant record in order to successfully create an + auth support login record. + + Request will require the following security scope: + **sp:auth-support-login:create** + +requestBody: + description: Auth support tenant creation request body. + required: true + content: + application/json: + schema: + $ref: "../../schemas/AuthSupportTenantRequest.yaml" +responses: + "200": + description: Created auth support tenant record. + content: + application/json: + schema: + $ref: "../../schemas/AuthSupportTenantResponse.yaml" + "400": + $ref: "../../responses/400.yaml" + "401": + $ref: "../../responses/401.yaml" + "403": + $ref: "../../responses/403.yaml" + "429": + $ref: "../../responses/429.yaml" + "500": + $ref: "../../responses/500.yaml" diff --git a/static/api-specs/idn/v2025/paths/supportlogin/auth-support-tenant-delete.yaml b/static/api-specs/idn/v2025/paths/supportlogin/auth-support-tenant-delete.yaml new file mode 100644 index 000000000..37883151e --- /dev/null +++ b/static/api-specs/idn/v2025/paths/supportlogin/auth-support-tenant-delete.yaml @@ -0,0 +1,19 @@ +operationId: authSupportTenantDelete +tags: + - Auth Support Login +summary: Delete all auth support tenant records for this tenant +description: >- + This request will delete all auth support tenant records related to the + requesting tenant. Request will require the following security scope: + **sp:auth-support-login:delete** +responses: + "204": + $ref: "../../responses/204.yaml" + "401": + $ref: "../../responses/401.yaml" + "403": + $ref: "../../responses/403.yaml" + "404": + $ref: "../../responses/404.yaml" + "500": + $ref: "../../responses/500.yaml" diff --git a/static/api-specs/idn/v2025/paths/supportlogin/auth-support-tenant-list.yaml b/static/api-specs/idn/v2025/paths/supportlogin/auth-support-tenant-list.yaml new file mode 100644 index 000000000..260c7ef44 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/supportlogin/auth-support-tenant-list.yaml @@ -0,0 +1,53 @@ +operationId: authSupportTenantList +tags: + - Auth Support Login +summary: List auth support tenant records +description: >- + Fetch list of auth support tenant records that can be used as authTenant. + Request will require the following security scope: + **sp:auth-support-login:read** +parameters: + - $ref: "../../parameters/limit.yaml" + - $ref: "../../parameters/offset.yaml" + - $ref: "../../parameters/count.yaml" + - in: query + name: sorters + schema: + type: string + format: comma-separated + description: >- + Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **authTenant** + example: authTenant + - in: query + name: filters + schema: + type: string + description: >- + 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: + + + **authTenant**: *eq, sw* + example: authTenant eq "sailpoint" +responses: + "200": + description: list of auth support tenant responses. + content: + application/json: + schema: + type: array + items: + $ref: "../../schemas/AuthSupportTenantResponse.yaml" + "400": + $ref: "../../responses/400.yaml" + "401": + $ref: "../../responses/401.yaml" + "403": + $ref: "../../responses/403.yaml" + "500": + $ref: "../../responses/500.yaml" diff --git a/static/api-specs/idn/v2025/paths/supportlogin/auth-support-tenants.yaml b/static/api-specs/idn/v2025/paths/supportlogin/auth-support-tenants.yaml new file mode 100644 index 000000000..209a2b20f --- /dev/null +++ b/static/api-specs/idn/v2025/paths/supportlogin/auth-support-tenants.yaml @@ -0,0 +1,7 @@ +get: + $ref: './auth-support-tenant-list.yaml' +post: + $ref: './auth-support-tenant-create.yaml' +delete: + $ref: './auth-support-tenant-delete.yaml' + diff --git a/static/api-specs/idn/v2025/paths/supportlogin/auth-support-user-eligibility-get.yaml b/static/api-specs/idn/v2025/paths/supportlogin/auth-support-user-eligibility-get.yaml new file mode 100644 index 000000000..ff8fa4b5a --- /dev/null +++ b/static/api-specs/idn/v2025/paths/supportlogin/auth-support-user-eligibility-get.yaml @@ -0,0 +1,29 @@ +get: + operationId: authSupportUserEligbilityGet + tags: + - Auth Support Login + summary: Get a user's eligibility for support and services login + description: >- + Fetch the auth support tenant record(s) associated with this user's tenant + and check to see if the user belongs to any access roles allowed for + performing support and services login + + Request requires an authenticated user, but no specific scope is required + for analysis of user eligibility. + responses: + "200": + description: + Response containing a determination of whether or not the logged-in user + is eligible to provide support to customers. + content: + application/json: + schema: + $ref: "../../schemas/AuthSupportUserEligibilityResponse.yaml" + "401": + $ref: "../../responses/401.yaml" + "403": + $ref: "../../responses/403.yaml" + "429": + $ref: "../../responses/429.yaml" + "500": + $ref: "../../responses/500.yaml" diff --git a/static/api-specs/idn/v2025/paths/sync-password.yaml b/static/api-specs/idn/v2025/paths/sync-password.yaml new file mode 100644 index 000000000..a0112e365 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/sync-password.yaml @@ -0,0 +1,60 @@ +post: + operationId: syncPassword + tags: + - Password + summary: Sync Identity's Password +# security: +# - oauth2: [API] + description: This API is reserved for password interceptor (PWI) to initiate a password change request for all sources in the sync group EXCEPT the source specified from the PasswordChangeRequest payload. To sync password for all sources in a source group, use set-password instead. The password can only be synced by a trusted API client application. + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/SyncPasswordRequest.yaml' + example: { + "identityId": "2c918085744fec4301746f9a5bce4605", + "encryptedPassword": "GIAP7TaAg7Y2EJtFojokBDvHQ/iXF3qk0z0+eLusqXMSkEhAfr34GydFLy+BM2uZB94cwbTYKi9rRrCRRdh8610VeqpRDjhuc28nOPYqTJOx09IGJdr8dl4mbhC1f21JCqMBBrFSA4VQQvd6OMVsceoXTjDI0aKahRYNjlMlsOuaIUZeNQxWBydLuR6vYG3qAKEPCzYZbvyYuBUylUWArfqwV4dgwKGDgDkTLBkQU9LVu3rssc+BXaex6l6JcBDiPg7wvKD1G3lZ+BaGrMknbx3j0T2Uivg+HxwTf7PmtAua6O9M7F984c79KM+sYFTU37MAdlWZu/cy+w2DdHVdCg==", + "publicKeyId": "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", + "accountId": "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", + "sourceId": "8a807d4c73c545510173c545d4b60246", + "uuid":"{ad9fc391-246d-40af-b248-b6556a2b7c01}", + "retryCount": "0", + "host": "host1.example.net", + "passwordSyncTime": "2021-01-08T18:46:56+00:00", + "pwiType": "AD", + "pwiVersion": "20.0.0", + "passwordChangeTime": "2021-01-08T18:45:50+00:00" + } + responses: + '202': + description: Reference to the password change. + content: + application/json: + schema: + $ref: '../schemas/PasswordChangeResponse.yaml' + examples: + Password sync is in progress: + value: + { + "state": "IN_PROGRESS", + "requestId": "089899f13a8f4da7824996191587bab9", + } + Password sync is finshed: + value: + { + "state": "FINISHED", + "identityRequestId": null, + } + '204': + description: No content - Indicates there is no processing for the PWI request. + content: + application/json: {} + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '500': + $ref: '../responses/500.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/system-accounts.yaml b/static/api-specs/idn/v2025/paths/system-accounts.yaml new file mode 100644 index 000000000..8503bfe9e --- /dev/null +++ b/static/api-specs/idn/v2025/paths/system-accounts.yaml @@ -0,0 +1,40 @@ +get: + operationId: getSystemAccount + tags: + - Accounts + summary: Get System Account For Identity + description: >- + Returns the system account given an identity ID. + + A token with ORG_ADMIN or API authority is required to call this API to get a the system account of an identity. + parameters: + - in: path + name: identityId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listIdentities + description: The Identity's ID + example: ef38f94347e94562b5bb8424a56397d8 + responses: + '200': + description: An account object + content: + application/json: + schema: + $ref: '../schemas/SlimAccount.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + security: + - userAuth: [idn:accounts:read] + diff --git a/static/api-specs/idn/v2025/paths/system-notification-config.yaml b/static/api-specs/idn/v2025/paths/system-notification-config.yaml new file mode 100644 index 000000000..9cf239745 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/system-notification-config.yaml @@ -0,0 +1,65 @@ +get: + operationId: getSystemNotificationConfiguration + tags: + - Notifications + summary: Get System Notification Configuration + description: >- + Returns the system notification configuration for a tenant. + security: + - userAuth: [ idn:notification-preferences:read ] + responses: + '200': + description: List of Email Status + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/SystemNotificationConfigDto.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + +put: + operationId: putSystemNotificationConfiguration + tags: + - Notifications + summary: Update the System Notification configuration + description: >- + Updates the System Notification configuration. + security: + - userAuth: [ idn:notification-preferences:create ] + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/SystemNotificationConfigDto.yaml' + example: + recipientType: "OVERRIDE_EMAILS" + overrideEmails: ["notified@example.com"] + + responses: + '200': + description: Update System Notification configuration + content: + application/json: + schema: + $ref: '../schemas/SystemNotificationConfigDto.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/tag.yaml b/static/api-specs/idn/v2025/paths/tag.yaml new file mode 100644 index 000000000..c24676c66 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/tag.yaml @@ -0,0 +1,97 @@ +get: + operationId: getTagById + tags: + - Tags + summary: Get Tag By Id + description: >- + Returns a tag by its id. + + + A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN + authority is required to call this API. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listTags + description: The ID of the object reference to retrieve. + example: 329d96cf-3bdb-40a9-988a-b5037ab89022 + responses: + '200': + description: Tag + content: + application/json: + schema: + $ref: '../schemas/Tag.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +delete: + operationId: deleteTagById + tags: + - Tags + summary: Delete Tag + description: >- + This API deletes a tag by specified id. + + + A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN + authority is required to call this API. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listTags + description: The ID of the object reference to delete. + example: 329d96cf-3bdb-40a9-988a-b5037ab89022 + responses: + '204': + description: No content. + '400': + description: Client Error - Returned if the request body is invalid. + content: + application/json: + schema: + $ref: '../schemas/ErrorResponseDto.yaml' + examples: + 400.1 Bad Request Content: + description: Response for bad request content + value: + detailCode: 400.1 Bad Request Content + trackingId: 1ea1adcb84da4dcb890145e05745774e + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The request was syntactically correct but its content is semantically invalid. + 400.2.1 Referential integrity violation: + description: Response for reference violations + value: + detailCode: 400.2.1 Referential integrity violation + trackingId: 33956b59f6d44081a11f91959dd8731d + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The request cannot be fulfilled because doing so would violate referential integrity constraints. + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/tagged-object.yaml b/static/api-specs/idn/v2025/paths/tagged-object.yaml new file mode 100644 index 000000000..b460ef750 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/tagged-object.yaml @@ -0,0 +1,155 @@ +get: + operationId: getTaggedObject + security: + - userAuth: [ idn:tag:read, idn:tag:manage ] + tags: + - Tagged Objects + summary: Get Tagged Object + description: >- + This gets a tagged object for the specified type. + parameters: + - in: path + name: type + schema: + type: string + enum: + - ACCESS_PROFILE + - APPLICATION + - CAMPAIGN + - ENTITLEMENT + - IDENTITY + - ROLE + - SOD_POLICY + - SOURCE + required: true + description: The type of tagged object to retrieve. + example: ROLE + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listTaggedObjects + description: The ID of the object reference to retrieve. + example: ef38f94347e94562b5bb8424a56397d8 + responses: + '200': + description: Tagged object by type and ID. + content: + application/json: + schema: + $ref: '../schemas/TaggedObject.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +put: + operationId: putTaggedObject + security: + - userAuth: [ idn:tag:manage ] + tags: + - Tagged Objects + summary: Update Tagged Object + description: >- + This updates a tagged object for the specified type. + parameters: + - in: path + name: type + schema: + type: string + enum: + - ACCESS_PROFILE + - APPLICATION + - CAMPAIGN + - ENTITLEMENT + - IDENTITY + - ROLE + - SOD_POLICY + - SOURCE + required: true + description: The type of tagged object to update. + example: ROLE + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listTaggedObjects + description: The ID of the object reference to update. + example: ef38f94347e94562b5bb8424a56397d8 + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/TaggedObject.yaml' + responses: + '200': + description: Tagged object by type and ID. + content: + application/json: + schema: + $ref: '../schemas/TaggedObject.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +delete: + operationId: deleteTaggedObject + security: + - userAuth: [ idn:tag:manage ] + tags: + - Tagged Objects + summary: Delete Object Tags + description: >- + Delete all tags from a tagged object. + parameters: + - in: path + name: type + schema: + type: string + enum: + - ACCESS_PROFILE + - APPLICATION + - CAMPAIGN + - ENTITLEMENT + - IDENTITY + - ROLE + - SOD_POLICY + - SOURCE + required: true + description: The type of object to delete tags from. + example: ROLE + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listTaggedObjects + description: The ID of the object to delete tags from. + example: ef38f94347e94562b5bb8424a56397d8 + responses: + '204': + description: No content. + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/tagged-objects-type.yaml b/static/api-specs/idn/v2025/paths/tagged-objects-type.yaml new file mode 100644 index 000000000..461833b0a --- /dev/null +++ b/static/api-specs/idn/v2025/paths/tagged-objects-type.yaml @@ -0,0 +1,68 @@ +get: + operationId: listTaggedObjectsByType + security: + - userAuth: [ idn:tag:read, idn:tag:manage ] + tags: + - Tagged Objects + summary: List Tagged Objects by Type + description: >- + This API returns a list of all tagged objects by type. + + + Any authenticated token may be used to call this API. + parameters: + - in: path + name: type + schema: + type: string + enum: + - ACCESS_PROFILE + - APPLICATION + - CAMPAIGN + - ENTITLEMENT + - IDENTITY + - ROLE + - SOD_POLICY + - SOURCE + required: true + description: The type of tagged object to retrieve. + example: ROLE + - $ref: '../parameters/limit.yaml' + - $ref: '../parameters/offset.yaml' + - $ref: '../parameters/count.yaml' + - in: query + name: filters + schema: + type: string + description: >- + 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: + + + **objectRef.id**: *eq* + + + **objectRef.type**: *eq* + example: objectRef.id eq "2c91808568c529c60168cca6f90c1313" + required: false + responses: + '200': + description: List of all tagged objects for specified type. + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/TaggedObject.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/tagged-objects.yaml b/static/api-specs/idn/v2025/paths/tagged-objects.yaml new file mode 100644 index 000000000..ecb1a286a --- /dev/null +++ b/static/api-specs/idn/v2025/paths/tagged-objects.yaml @@ -0,0 +1,86 @@ +get: + operationId: listTaggedObjects + security: + - userAuth: [ idn:tag:read, idn:tag:manage ] + tags: + - Tagged Objects + summary: List Tagged Objects + description: >- + This API returns a list of all tagged objects. + + + Any authenticated token may be used to call this API. + parameters: + - $ref: '../parameters/limit.yaml' + - $ref: '../parameters/offset.yaml' + - $ref: '../parameters/count.yaml' + - in: query + name: filters + schema: + type: string + description: >- + 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: + + + **objectRef.id**: *eq, in* + + + **objectRef.type**: *eq, in* + + + **tagName**: *eq, in* + example: tagName eq "BU_FINANCE" + required: false + responses: + '200': + description: List of all tagged objects. + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/TaggedObject.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +post: + operationId: setTagToObject + security: + - userAuth: [ idn:tag:manage ] + tags: + - Tagged Objects + summary: Add Tag to Object + description: >- + This adds a tag to an object. + + + Any authenticated token may be used to call this API. + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/TaggedObject.yaml' + responses: + '201': + description: Created. + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/tags-get-shared.yaml b/static/api-specs/idn/v2025/paths/tags-get-shared.yaml new file mode 100644 index 000000000..6462b290b --- /dev/null +++ b/static/api-specs/idn/v2025/paths/tags-get-shared.yaml @@ -0,0 +1,39 @@ +post: + operationId: searchSharedTags + security: + - userAuth: [ idn:tag:manage ] + tags: + - Tags + summary: Get Shared Tags + description: >- + This API returns the tags shared among specified objects. + + + A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN + authority is required to call this API. + requestBody: + required: true + description: Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + content: + application/json: + schema: + $ref: '../schemas/BulkTaggedObject.yaml' + responses: + '200': + description: Request succeeded. + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/Tag.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/tags.yaml b/static/api-specs/idn/v2025/paths/tags.yaml new file mode 100644 index 000000000..d3b420481 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/tags.yaml @@ -0,0 +1,120 @@ +get: + operationId: listTags + tags: + - Tags + summary: List Tags + description: >- + This API returns a list of tags. + + + A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN + authority is required to call this API. + parameters: + - $ref: '../parameters/limit.yaml' + - $ref: '../parameters/offset.yaml' + - $ref: '../parameters/count.yaml' + - in: query + name: filters + schema: + type: string + description: >- + Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) + + + Filtering is supported for the following fields and operators: + + + **id**: *eq, in* + + + **name**: *eq, in, sw* + example: id eq "27462f54-61c7-4140-b5da-d5dbe27fc6db" + required: false + - in: query + name: sorters + schema: + type: string + format: comma-separated + description: >- + Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **id, name, created, modified** + example: name,-modified + required: false + responses: + '200': + description: List of all tags. + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/Tag.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +post: + operationId: createTag + tags: + - Tags + summary: Create Tag + description: >- + This API creates new tag. + + + A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN + authority is required to call this API. + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/Tag.yaml' + responses: + '201': + description: Created tag. + content: + application/json: + schema: + $ref: '../schemas/Tag.yaml' + '400': + description: Client Error - Returned if the request body is invalid. + content: + application/json: + schema: + $ref: '../schemas/ErrorResponseDto.yaml' + examples: + 400.1 Bad Request Content: + description: Response for bad request content + value: + detailCode: 400.1 Bad Request Content + trackingId: 1ea1adcb84da4dcb890145e05745774e + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The request was syntactically correct but its content is semantically invalid. + 400.1.2 Value length out of range: + description: Response for invalid tag name + value: + detailCode: 400.2.1 Referential integrity violation + trackingId: 2241d18b9e7d4350a9acfe69f8ce47f1 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: Field "Tag Name" length is outside of range [3,128]. + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/task-definition.yaml b/static/api-specs/idn/v2025/paths/task-definition.yaml new file mode 100644 index 000000000..bc5f30f0d --- /dev/null +++ b/static/api-specs/idn/v2025/paths/task-definition.yaml @@ -0,0 +1,85 @@ +# +# Copyright (C) 2019-2020 SailPoint Technologies, Inc. All rights reserved. +# +get: + tags: + - Task Management + summary: Retrieves a task definition summary + description: Get a specified TaskDefinitionSummary. + operationId: getTaskDefinitionSummary + parameters: + - name: id + in: path + description: ID of the TaskDefinition to get a summary for + required: true + x-sailpoint-resource-operation-id: getTaskDefinitionSummaryList + style: simple + explode: false + schema: + type: string + example: taskDefId + responses: + "200": + description: TaskDefinitionSummary with the given task definition ID + content: + application/json: + schema: + $ref: '../schemas/TaskDefinitionSummary.yaml' + "400": + $ref: '../responses/400.yaml' + "401": + $ref: '../responses/401.yaml' + "403": + $ref: '../responses/403.yaml' + "404": + $ref: '../responses/404.yaml' + "429": + $ref: '../responses/429.yaml' + "500": + $ref: '../responses/500.yaml' + security: + - userAuth: [idn:task-definition:read, idn:task-definition:manage] +patch: + tags: + - Task Management + summary: Patch a specified TaskDefinition. + description: Update an existing TaskDefinition using PATCH. + operationId: patchTaskDefinition + parameters: + - name: id + in: path + description: ID of the TaskDefinition to patch + required: true + x-sailpoint-resource-operation-id: getTaskDefinitionSummaryList + style: simple + explode: false + schema: + type: string + example: taskDefId + requestBody: + content: + application/json-patch+json: + schema: + $ref: '../schemas/JsonPatch.yaml' + required: true + responses: + "200": + description: Responds with the TaskDefinition as updated. + content: + application/json: + schema: + $ref: '../schemas/TaskDefinitionSummary.yaml' + "400": + $ref: '../responses/400.yaml' + "401": + $ref: '../responses/401.yaml' + "403": + $ref: '../responses/403.yaml' + "404": + $ref: '../responses/404.yaml' + "429": + $ref: '../responses/429.yaml' + "500": + $ref: '../responses/500.yaml' + security: + - userAuth: [idn:task-definition:manage] diff --git a/static/api-specs/idn/v2025/paths/task-definitions.yaml b/static/api-specs/idn/v2025/paths/task-definitions.yaml new file mode 100644 index 000000000..836c75c1e --- /dev/null +++ b/static/api-specs/idn/v2025/paths/task-definitions.yaml @@ -0,0 +1,30 @@ +# +# Copyright (C) 2019-2020 SailPoint Technologies, Inc. All rights reserved. +# +get: + tags: + - Task Management + summary: Retrieve a task definition summary list. + description: Get a list of TaskDefinitionSummary. + operationId: getTaskDefinitionSummaryList + parameters: + - $ref: '../parameters/offset.yaml' + - $ref: '../parameters/limit.yaml' + - $ref: '../parameters/count.yaml' + responses: + "200": + description: Response is a list of TaskDefinitionSumary results matching the criteria. + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/TaskDefinitionSummary.yaml' + "204": + $ref: '../responses/204.yaml' + "400": + $ref: '../responses/400.yaml' + "403": + $ref: '../responses/403.yaml' + security: + - userAuth: [idn:task-definition:read] diff --git a/static/api-specs/idn/v2025/paths/task-execution-cancel.yaml b/static/api-specs/idn/v2025/paths/task-execution-cancel.yaml new file mode 100644 index 000000000..4d1ccd6d4 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/task-execution-cancel.yaml @@ -0,0 +1,29 @@ +# +# Copyright (C) 2019-2020 SailPoint Technologies, Inc. All rights reserved. +# +post: + tags: + - Task Management + summary: Cancel a task by ID + description: Cancel a task by task ID. + operationId: cancelTask + parameters: + - name: id + in: path + description: Task ID of task to cancel + required: true + x-sailpoint-resource-operation-id: getPendingTasks + style: simple + explode: false + schema: + type: string + example: anId + responses: + "200": + description: Response indicating that the Task with the given ID was successfully cancelled. + "403": + $ref: '../responses/403.yaml' + "404": + $ref: '../responses/404.yaml' + security: + - userAuth: [idn:task-management:write] diff --git a/static/api-specs/idn/v2025/paths/task-execution-run.yaml b/static/api-specs/idn/v2025/paths/task-execution-run.yaml new file mode 100644 index 000000000..e1c391dc6 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/task-execution-run.yaml @@ -0,0 +1,28 @@ +# +# Copyright (C) 2019-2020 SailPoint Technologies, Inc. All rights reserved. +# +post: + tags: + - Task Management + summary: Run a task. + description: Run a task. + operationId: runTask + requestBody: + content: + application/json: + schema: + $ref: '../schemas/TaskInvocation.yaml' + required: true + responses: + "200": + description: Responds with an initial TaskStatus for the executed task. + content: + application/json: + schema: + $ref: '../schemas/TaskStatus.yaml' + "400": + $ref: '../responses/400.yaml' + "403": + $ref: '../responses/403.yaml' + security: + - userAuth: [idn:task-management:write] diff --git a/static/api-specs/idn/v2025/paths/task-status-list.yaml b/static/api-specs/idn/v2025/paths/task-status-list.yaml new file mode 100644 index 000000000..d74d80d7c --- /dev/null +++ b/static/api-specs/idn/v2025/paths/task-status-list.yaml @@ -0,0 +1,87 @@ +get: + tags: + - Task Management + summary: Retrieve Task Status List + description: | + Use this endpoint to get a list of statuses for **completed** tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. To get a list of statuses for **in-progress** tasks, please use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/v2024/get-pending-tasks) endpoint. + operationId: getTaskStatusList + parameters: + - $ref: ../parameters/limit.yaml + - $ref: ../parameters/offset.yaml + - $ref: ../parameters/count.yaml + - in: query + name: filters + schema: + type: string + example: completionStatus eq "Success" + required: false + description: 'Filter results using the standard syntax described in [V3 API Standard + Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) + + + Filtering is supported for the following fields and operators: + + + **id**: *eq, in* + + + **sourceId**: *eq, in* + + + **completionStatus**: *eq, in* + + + **type**: *eq, in*' + - in: query + name: sorters + schema: + type: string + format: comma-separated + example: -created + required: false + description: 'Sort results using the standard syntax described in [V3 API Standard + Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **created**' + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Responds with a TaskStatus for the task with the given task ID. + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/TaskStatus.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: [idn:task-management:read, idn:task-management:write] + - applicationAuth: [idn:task-management:read, idn:task-management:write] + x-sailpoint-userLevels: + - ORG_ADMIN + - HELPDESK + - CERT_ADMIN + - REPORT_ADMIN + - ROLE_ADMIN + - ROLE_SUBADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/task-status-pending.yaml b/static/api-specs/idn/v2025/paths/task-status-pending.yaml new file mode 100644 index 000000000..df189e6d8 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/task-status-pending.yaml @@ -0,0 +1,96 @@ +get: + tags: + - Task Management + summary: Retrieve Pending Task Status List + description: Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. + operationId: getPendingTasks + parameters: + - $ref: ../parameters/offset.yaml + - $ref: ../parameters/limit.yaml + - $ref: ../parameters/count.yaml + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Responds with a list of TaskStatus for pending tasks. + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/TaskStatus.yaml + '204': + $ref: ../responses/204.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: [idn:task-management:read, idn:task-management:write] + - applicationAuth: [idn:task-management:read, idn:task-management:write] + x-sailpoint-userLevels: + - ORG_ADMIN + - HELPDESK + - CERT_ADMIN + - REPORT_ADMIN + - ROLE_ADMIN + - ROLE_SUBADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN +head: + tags: + - Task Management + summary: Retrieve Pending Task List Headers + description: Responds with headers only for list of task statuses for pending tasks. + operationId: getPendingTaskHeaders + parameters: + - $ref: ../parameters/offset.yaml + - $ref: ../parameters/limit.yaml + - $ref: ../parameters/count.yaml + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Retrieve headers for a list of TaskStatus for pending tasks. + '204': + $ref: ../responses/204.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: [idn:task-management:read, idn:task-management:write] + - applicationAuth: [idn:task-management:read, idn:task-management:write] + x-sailpoint-userLevels: + - ORG_ADMIN + - HELPDESK + - CERT_ADMIN + - REPORT_ADMIN + - ROLE_ADMIN + - ROLE_SUBADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/task-status.yaml b/static/api-specs/idn/v2025/paths/task-status.yaml new file mode 100644 index 000000000..901cba5d4 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/task-status.yaml @@ -0,0 +1,127 @@ +get: + tags: + - Task Management + summary: Get Task Status by ID + description: Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. + operationId: getTaskStatus + parameters: + - name: id + in: path + description: Task ID. + required: true + x-sailpoint-resource-operation-id: getTaskStatusList + example: 00eebcf881994e419d72e757fd30dc0e + style: simple + explode: false + schema: + type: string + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: Responds with a TaskStatus for the task with the given task ID. + content: + application/json: + schema: + $ref: ../schemas/TaskStatus.yaml + '403': + description: Forbidden, generally due to a lack of security rights + '404': + description: TaskStatus with the given id was not found. + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: [idn:task-management:read, idn:task-management:write] + - applicationAuth: [idn:task-management:read, idn:task-management:write] + x-sailpoint-userLevels: + - ORG_ADMIN + - HELPDESK + - CERT_ADMIN + - REPORT_ADMIN + - ROLE_ADMIN + - ROLE_SUBADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN +patch: + operationId: updateTaskStatus + tags: + - Task Management + summary: Update Task Status by ID + description: Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. + parameters: + - name: id + in: path + description: Task ID. + example: 00eebcf881994e419d72e757fd30dc0e + required: true + x-sailpoint-resource-operation-id: getTaskStatusList + style: simple + explode: false + schema: + type: string + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + requestBody: + required: true + description: The JSONPatch payload used to update the object. + content: + application/json-patch+json: + schema: + type: array + items: + $ref: ../schemas/JsonPatchOperation.yaml + example: + - op: replace + path: /completionStatus + value: Error + - op: replace + path: /completed + value: 2024-05-17 19:33:16.470000+00:00 + responses: + '200': + description: This response indicates the PATCH operation succeeded, and the + API returns the updated task object. + content: + application/json: + schema: + $ref: ../schemas/TaskStatus.yaml + '400': + $ref: ../responses/400.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '401': + $ref: ../responses/401.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: [idn:task-management:write] + x-sailpoint-userLevels: + - ORG_ADMIN + - CERT_ADMIN + - REPORT_ADMIN + - ROLE_ADMIN + - ROLE_SUBADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/tenant-configuration.yaml b/static/api-specs/idn/v2025/paths/tenant-configuration.yaml new file mode 100644 index 000000000..ac68744fb --- /dev/null +++ b/static/api-specs/idn/v2025/paths/tenant-configuration.yaml @@ -0,0 +1,80 @@ +get: + operationId: getTenantConfigConfiguration + tags: + - Work Reassignment + summary: Get Tenant-wide Reassignment Configuration settings + description: Gets the global Reassignment Configuration settings for the requestor's + tenant. + security: + - userAuth: + - idn:reassignment-tenant-configuration:read + responses: + '200': + description: Tenant-wide Reassignment Configuration settings + content: + application/json: + schema: + $ref: ../schemas/work-reassignment/TenantConfigurationResponse.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true +put: + operationId: putTenantConfiguration + tags: + - Work Reassignment + summary: Update Tenant-wide Reassignment Configuration settings + description: Replaces existing Tenant-wide Reassignment Configuration settings with + the newly provided settings. + security: + - userAuth: + - idn:reassignment-tenant-configuration:update + requestBody: + required: true + content: + application/json: + schema: + $ref: ../schemas/work-reassignment/TenantConfigurationRequest.yaml + responses: + '200': + description: Tenant-wide Reassignment Configuration settings + content: + application/json: + schema: + $ref: ../schemas/work-reassignment/TenantConfigurationResponse.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true diff --git a/static/api-specs/idn/v2025/paths/tenant-context.yaml b/static/api-specs/idn/v2025/paths/tenant-context.yaml new file mode 100644 index 000000000..7249e664a --- /dev/null +++ b/static/api-specs/idn/v2025/paths/tenant-context.yaml @@ -0,0 +1,189 @@ +get: + summary: Retrieve tenant context + tags: + - Tenant Context + description: > + Returns a list of key-value pairs representing the current state of the tenant's context. + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + security: + - userAuth: [idn:tenant-context:read] + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN + operationId: getTenantContext + responses: + '200': + description: Successfully retrieved tenant context. + content: + application/json: + schema: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + example: + - key: "IAS" + value: "International Accounting Standards" + '400': + $ref: ../../v2024/responses/400.yaml + '401': + $ref: ../../v2024/responses/401.yaml + '403': + $ref: ../../v2024/responses/403.yaml + '429': + $ref: ../../v2024/responses/429.yaml + '500': + $ref: ../../v2024/responses/500.yaml +patch: + summary: Update tenant context + tags: + - Tenant Context + description: > + Allows the user to make incremental updates to tenant context records using [JSON Patch](https://tools.ietf.org/html/rfc6902) + syntax. + + + This endpoint is specifically designed to modify the `/Key/*` field, supporting operations such as `add`, `remove`, or `replace` to manage key-value pairs. + + + Note that each tenant is limited to a maximum of 100 key-value pairs. + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + security: + - userAuth: [idn:tenant-context:write] + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN + operationId: patchTenantContext + requestBody: + content: + application/json-patch+json: + schema: + $ref: '../schemas/JsonPatchOperation.yaml' + examples: + Multiple operations in one call: + description: This example shows how multiple context keys may be updated with a single patch call. + value: + [ + { + "op": "add", + "path": "/Key/IAS", + "value": "Integrated Automation System" + }, + { + "op": "replace", + "path": "/Key/IAS", + "value": "International Accounting Standards" + }, + { + "op": "remove", + "path": "/Key/NDR" + } + ] + Add a single context: + description: This example shows how a single context may be created with a single patch call. + value: + [ + { + "op": "add", + "path": "/Key/IAS", + "value": "Integrated Automation System" + } + ] + Update a single context: + description: This example shows how a single context may be updated with a single patch call. + value: + [ + { + "op": "replace", + "path": "/Key/IAS", + "value": "International Accounting Standards" + } + ] + Remove a single context: + description: This example shows how a single context may be removed with a single patch call. + value: + [ + { + "op": "remove", + "path": "/Key/IAS" + } + ] + required: true + responses: + '200': + description: Tenant context updated successfully. + '400': + description: Bad request due to invalid input parameters. + content: + application/json: + schema: + $ref: "../../v2024/schemas/ErrorResponseDto.yaml" + examples: + incorrectPath: + summary: Invalid Path Example + value: + detailCode: "Bad Request" + trackingId: "e9eaaeac516643ffa087cc476e7577c5" + messages: + - locale: "en-US" + localeOrigin: "DEFAULT" + text: "invalid patch request: field not patchable or does not contain key (/InvalidPath/IAS)" + invalidOperation: + summary: Invalid Operation Example + value: + detailCode: "Bad Request" + trackingId: "39cfb6a29d5a4522954d72124545d3c5" + messages: + - locale: "en-US" + localeOrigin: "DEFAULT" + text: "invalid patch request: operation not allowed (move)" + noKeyInPath: + summary: No Key in Path Example + value: + detailCode: "Bad Request" + trackingId: "6d3bdd67ac8a4382884875ed4abf1f13" + messages: + - locale: "en-US" + localeOrigin: "DEFAULT" + text: "invalid patch request: field not patchable or does not contain key (/Key/)" + capacityExceeded: + summary: Capacity Exceeded Example + value: + detailCode: "Bad Request" + trackingId: "bd51a5e2f4ee4d5aa65ac2f7cd3c2445" + messages: + - locale: "en-US" + localeOrigin: "DEFAULT" + text: "unable to fulfill patch request: max tenant context capacity exceeded by 5 key/value pair(s)" + '401': + $ref: ../../v2024/responses/401.yaml + '403': + $ref: ../../v2024/responses/403.yaml + '404': + $ref: ../../v2024/responses/404.yaml + '429': + $ref: ../../v2024/responses/429.yaml + '500': + $ref: ../../v2024/responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/tenant.yaml b/static/api-specs/idn/v2025/paths/tenant.yaml new file mode 100644 index 000000000..3c6b4c378 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/tenant.yaml @@ -0,0 +1,30 @@ +get: + operationId: getTenant + tags: + - Tenant + summary: Get Tenant Information. + description: This rest endpoint can be used to retrieve tenant details. + security: + - userAuth: + - sp:tenant:read + x-sailpoint-userLevels: + - Any + responses: + '200': + description: Tenant Info + content: + application/json: + schema: + $ref: ../schemas/Tenant.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/transform.yaml b/static/api-specs/idn/v2025/paths/transform.yaml new file mode 100644 index 000000000..7c2f9e26f --- /dev/null +++ b/static/api-specs/idn/v2025/paths/transform.yaml @@ -0,0 +1,139 @@ +get: + tags: + - Transforms + summary: Transform by ID + description: >- + This API returns the transform specified by the given ID. + operationId: getTransform + parameters: + - name: id + in: path + description: ID of the transform to retrieve + required: true + x-sailpoint-resource-operation-id: listTransforms + style: simple + explode: false + example: 2cd78adghjkja34jh2b1hkjhasuecd + schema: + type: string + responses: + "200": + description: Transform with the given ID + content: + application/json: + schema: + $ref: '../schemas/TransformRead.yaml' + "400": + $ref: '../responses/400.yaml' + "401": + $ref: '../responses/401.yaml' + "403": + $ref: '../responses/403.yaml' + "404": + $ref: '../responses/404.yaml' + "429": + $ref: '../responses/429.yaml' + "500": + $ref: '../responses/500.yaml' + security: + - userAuth: [idn:transform:read, idn:transform:manage] + x-sailpoint-userLevels: + - ORG_ADMIN +put: + tags: + - Transforms + summary: Update a transform + description: >- + Replaces the transform specified by the given ID with the transform provided in the request body. Only the + "attributes" field is mutable. Attempting to change other properties (ex. "name" and "type") will result in an error. + operationId: updateTransform + parameters: + - name: id + in: path + description: ID of the transform to update + required: true + x-sailpoint-resource-operation-id: listTransforms + style: simple + explode: false + schema: + type: string + example: 2cd78adghjkja34jh2b1hkjhasuecd + requestBody: + description: >- + The updated transform object. Must include "name", "type", and "attributes" fields, but "name" and "type" must not be modified. + content: + application/json: + schema: + $ref: '../schemas/Transform.yaml' + example: + name: Timestamp To Date + type: dateFormat + attributes: { "inputFormat": "MMM-dd-yyyy, HH:mm:ss.SSS", "outputFormat": "yyyy/dd/MM" } + responses: + "200": + description: Indicates the transform was successfully updated and returns its new representation. + content: + application/json: + schema: + $ref: '../schemas/TransformRead.yaml' + example: + id: 2cd78adghjkja34jh2b1hkjhasuecd + name: Timestamp To Date + type: dateFormat + attributes: { "inputFormat": "MMM-dd-yyyy, HH:mm:ss.SSS", "outputFormat": "yyyy/dd/MM" } + internal: false + "400": + $ref: '../responses/400.yaml' + "401": + $ref: '../responses/401.yaml' + "403": + $ref: '../responses/403.yaml' + "404": + $ref: '../responses/404.yaml' + "429": + $ref: '../responses/429.yaml' + "500": + $ref: '../responses/500.yaml' + security: + - userAuth: [idn:transform:manage] + x-sailpoint-userLevels: + - ORG_ADMIN +delete: + tags: + - Transforms + summary: Delete a transform + description: >- + Deletes the transform specified by the given ID. + Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. + If this occurs, you must first remove the transform from all mappings before deleting the transform. + operationId: deleteTransform + parameters: + - name: id + in: path + description: ID of the transform to delete + required: true + x-sailpoint-resource-operation-id: listTransforms + style: simple + explode: false + schema: + type: string + example: 2cd78adghjkja34jh2b1hkjhasuecd + responses: + "204": + $ref: '../responses/204.yaml' + "400": + $ref: '../responses/400.yaml' + "401": + $ref: '../responses/401.yaml' + "403": + $ref: '../responses/403.yaml' + "404": + $ref: '../responses/404.yaml' + "429": + $ref: '../responses/429.yaml' + "500": + $ref: '../responses/500.yaml' + security: + - userAuth: [idn:transform:manage] + x-sailpoint-userLevels: + - ORG_ADMIN diff --git a/static/api-specs/idn/v2025/paths/transforms.yaml b/static/api-specs/idn/v2025/paths/transforms.yaml new file mode 100644 index 000000000..e129f6030 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/transforms.yaml @@ -0,0 +1,119 @@ +get: + tags: + - Transforms + summary: List transforms + description: >- + Gets a list of all saved transform objects. + operationId: listTransforms + parameters: + - $ref: '../parameters/offset.yaml' + - $ref: '../parameters/limit.yaml' + - $ref: '../parameters/count.yaml' + - name: name + in: query + description: >- + Name of the transform to retrieve from the list. + required: false + style: form + schema: + type: string + example: "ExampleTransformName123" + - name: filters + in: query + description: >- + 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: + + + **internal**: *eq* + + + **name**: *eq, sw* + required: false + style: form + explode: true + example: name eq "Uppercase" + schema: + type: string + responses: + "200": + description: A list of transforms matching the given criteria. + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/TransformRead.yaml' + example: + - id: 2cd78adghjkja34jh2b1hkjhasuecd + name: Timestamp To Date + type: dateFormat + attributes: { "inputFormat": "MMM-dd-yyyy, HH:mm:ss.SSS", "outputFormat": "yyyy/dd/MM" } + internal: false + - id: 2lkas8dhj4bkuakja77giih7l4ashh + name: PrefixSubstring + type: substring + attributes: { "begin": 0, "end": 3 } + internal: true + "400": + $ref: '../responses/400.yaml' + "401": + $ref: '../responses/401.yaml' + "403": + $ref: '../responses/403.yaml' + "404": + $ref: '../responses/404.yaml' + "429": + $ref: '../responses/429.yaml' + "500": + $ref: '../responses/500.yaml' + security: + - userAuth: [idn:transform:read, idn:transform:manage] + x-sailpoint-userLevels: + - ORG_ADMIN +post: + tags: + - Transforms + summary: Create transform + description: >- + Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is + a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. + Newly created Transforms can be used in the Identity Profile mappings within the UI. + operationId: createTransform + requestBody: + required: true + description: >- + The transform to be created. + content: + application/json: + schema: + $ref: '../schemas/Transform.yaml' + example: + name: Timestamp To Date + type: dateFormat + attributes: { "inputFormat": "MMM dd yyyy, HH:mm:ss.SSS", "outputFormat": "yyyy/dd/MM" } + responses: + "201": + description: Indicates the transform was successfully created and returns its representation. + content: + application/json: + schema: + $ref: '../schemas/TransformRead.yaml' + "400": + $ref: '../responses/400.yaml' + "401": + $ref: '../responses/401.yaml' + "403": + $ref: '../responses/403.yaml' + "404": + $ref: '../responses/404.yaml' + "429": + $ref: '../responses/429.yaml' + "500": + $ref: '../responses/500.yaml' + security: + - userAuth: [idn:transform:manage] + x-sailpoint-userLevels: + - ORG_ADMIN diff --git a/static/api-specs/idn/v2025/paths/trigger-invocations-complete.yaml b/static/api-specs/idn/v2025/paths/trigger-invocations-complete.yaml new file mode 100644 index 000000000..ac154c61e --- /dev/null +++ b/static/api-specs/idn/v2025/paths/trigger-invocations-complete.yaml @@ -0,0 +1,46 @@ +post: + operationId: completeTriggerInvocation + tags: + - Triggers + summary: Complete Trigger Invocation + description: Completes an invocation to a REQUEST_RESPONSE type trigger. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listTriggerInvocationStatus + description: The ID of the invocation to complete. + example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + requestBody: + required: true + content: + application/json: + schema: + $ref: ../schemas/CompleteInvocation.yaml + example: + secret: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + output: + approved: false + responses: + '204': + $ref: ../responses/204.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/trigger-invocations-pending-events.yaml b/static/api-specs/idn/v2025/paths/trigger-invocations-pending-events.yaml new file mode 100644 index 000000000..35027518b --- /dev/null +++ b/static/api-specs/idn/v2025/paths/trigger-invocations-pending-events.yaml @@ -0,0 +1,56 @@ +get: + operationId: listPendingEvents + tags: + - Triggers + summary: List Pending Events + description: Get a list of event status, i.e. count of persisted, pending events per topic. + parameters: + - $ref: '../parameters/limit.yaml' + - $ref: '../parameters/offset.yaml' + - $ref: '../parameters/count.yaml' + - in: query + name: filters + required: false + schema: + type: string + description: >- + 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: + + + **topic**: *eq* + example: topic eq "Channel" + - in: query + name: sorters + required: false + schema: + type: string + format: comma-separated + description: >- + Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **topic** + example: topic + responses: + '200': + description: >- + List of pending events + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/EventStatus.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/trigger-invocations-start.yaml b/static/api-specs/idn/v2025/paths/trigger-invocations-start.yaml new file mode 100644 index 000000000..105d1abbf --- /dev/null +++ b/static/api-specs/idn/v2025/paths/trigger-invocations-start.yaml @@ -0,0 +1,41 @@ +post: + operationId: startInvocation + tags: + - Triggers + summary: Start Invocation + description: Start a trigger invocation with specified trigger input and contentJson context. + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/StartInvocationInput.yaml' + example: + triggerId: "idn:access-requested" + input: {"identityId": "201327fda1c44704ac01181e963d463c"} + contentJson: {"workflowId": 1234} + + responses: + '200': + description: >- + Trigger invocations that have been started for subscription(s) to specified trigger. + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/Invocation.yaml' + + '204': + $ref: '../responses/204.yaml' + description: Trigger invocation is skipped, because tenant has not subscribed to the specified trigger. + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/trigger-invocations-status.yaml b/static/api-specs/idn/v2025/paths/trigger-invocations-status.yaml new file mode 100644 index 000000000..2b65a2e61 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/trigger-invocations-status.yaml @@ -0,0 +1,77 @@ +get: + operationId: listTriggerInvocationStatus + tags: + - Triggers + summary: List Latest Invocation Statuses + description: 'Gets a list of latest invocation statuses. + + Statuses of successful invocations are available for up to 24 hours. Statuses + of failed invocations are available for up to 48 hours. + + This endpoint may only fetch up to 2000 invocations, and should not be treated + as a representation of the full history of invocations.' + parameters: + - $ref: ../parameters/limit.yaml + - $ref: ../parameters/offset.yaml + - $ref: ../parameters/count.yaml + - in: query + name: filters + required: false + schema: + type: string + description: '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: + + + **triggerId**: *eq* + + + **subscriptionId**: *eq*' + example: triggerId eq "idn:access-request-dynamic-approver" + - in: query + name: sorters + required: false + schema: + type: string + format: comma-separated + description: 'Sort results using the standard syntax described in [V3 API Standard + Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **triggerId, subscriptionName, + created, completed**' + example: created + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: List of latest invocation statuses. + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/InvocationStatus.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: + - sp:trigger-service-invocation-status:read + - sp:trigger-service-invocation-status:manage diff --git a/static/api-specs/idn/v2025/paths/trigger-invocations-test.yaml b/static/api-specs/idn/v2025/paths/trigger-invocations-test.yaml new file mode 100644 index 000000000..e6a2200be --- /dev/null +++ b/static/api-specs/idn/v2025/paths/trigger-invocations-test.yaml @@ -0,0 +1,64 @@ +post: + operationId: startTestTriggerInvocation + tags: + - Triggers + summary: Start a Test Invocation + description: Initiate a test event for all subscribers of the specified event trigger. If + there are no subscribers to the specified trigger in the tenant, then no test + event will be sent. + requestBody: + required: true + content: + application/json: + schema: + $ref: ../schemas/TestInvocation.yaml + examples: + Test Trigger with Mock Input: + value: + triggerId: idn:access-requested + input: + identityId: 201327fda1c44704ac01181e963d463c + contentJson: + workflowId: 1234 + Send Test to only One Subscriber: + value: + triggerId: idn:access-requested + contentJson: + workflowId: 1234 + subscriptionIds: + - 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + responses: + '200': + description: Test trigger invocations that have been started for specified subscription(s). + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/Invocation.yaml + '204': + $ref: ../responses/204.yaml + description: Trigger invocation is skipped, because tenant has not subscribed + to the specified trigger. + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: + - sp:trigger-service-invocation-status:manage + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true diff --git a/static/api-specs/idn/v2025/paths/trigger-invocations.yaml b/static/api-specs/idn/v2025/paths/trigger-invocations.yaml new file mode 100644 index 000000000..156772243 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/trigger-invocations.yaml @@ -0,0 +1,59 @@ +get: + operationId: listTriggerInvocations + tags: + - Triggers + summary: List Trigger Invocations + description: Get a list of trigger invocations that are currently in progress. + parameters: + - $ref: '../parameters/limit.yaml' + - $ref: '../parameters/offset.yaml' + - $ref: '../parameters/count.yaml' + - in: query + name: filters + required: false + schema: + type: string + description: >- + Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) + + + Filtering is supported for the following fields and operators: + + + **id**: *eq* + + + **triggerId**: *eq* + example: triggerId eq "idn:access-request-dynamic-approver" + - in: query + name: sorters + required: false + schema: + type: string + format: comma-separated + description: >- + Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **triggerId** + example: triggerId + responses: + '200': + description: >- + List of trigger invocations + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/ActiveInvocation.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/trigger-subscription.yaml b/static/api-specs/idn/v2025/paths/trigger-subscription.yaml new file mode 100644 index 000000000..385068d1e --- /dev/null +++ b/static/api-specs/idn/v2025/paths/trigger-subscription.yaml @@ -0,0 +1,192 @@ +put: + operationId: updateSubscription + tags: + - Triggers + summary: Update a Subscription + description: "This API updates a trigger subscription in IdentityNow, using a full\ + \ object representation. In other words, the existing\n Subscription is completely\ + \ replaced. The following fields are immutable:\n\n\n * id\n\n * triggerId\n\ + \n\n Attempts to modify these fields result in 400." + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSubscriptions + description: Subscription ID + example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + requestBody: + required: true + content: + application/json: + schema: + $ref: ../schemas/SubscriptionPutRequest.yaml + examples: + HTTP Subscription: + value: + name: Access request subscription + description: Access requested to site xyz + type: HTTP + httpConfig: + url: https://www.example.com + httpDispatchMode: SYNC + httpAuthenticationType: BASIC_AUTH + basicAuthConfig: + userName: user@example.com + password: eRtg4%6yuI! + enabled: true + filter: $[?($.identityId == "201327fda1c44704ac01181e963d463c")] + HTTP Async Subscription: + value: + name: Access request subscription + description: Access requested to site xyz + type: HTTP + responseDeadline: PT1H + httpConfig: + url: https://www.example.com + httpDispatchMode: ASYNC + httpAuthenticationType: BASIC_AUTH + basicAuthConfig: + userName: user@example.com + password: eRtg4%6yuI! + enabled: true + filter: $[?($.identityId == "201327fda1c44704ac01181e963d463c")] + EventBridge Subscription: + value: + name: Access request subscription + description: Access requested to site xyz + type: EVENTBRIDGE + eventBridgeConfig: + awsAccount: '123456789012' + awsRegion: us-west-1 + enabled: true + filter: $[?($.identityId == "201327fda1c44704ac01181e963d463c")] + responses: + '200': + description: Updated subscription. + content: + application/json: + schema: + $ref: ../schemas/Subscription.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: + - sp:trigger-service-subscriptions:manage +patch: + operationId: patchSubscription + tags: + - Triggers + summary: Patch a Subscription + description: 'This API updates a trigger subscription in IdentityNow, using a set + of instructions to modify a subscription partially. The following fields are patchable: + + + **name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, + **httpConfig**, **eventBridgeConfig**, **workflowConfig**' + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSubscriptions + description: ID of the Subscription to patch + example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + requestBody: + required: true + content: + application/json-patch+json: + schema: + $ref: ../schemas/SubscriptionPatchRequest.yaml + responses: + '200': + description: Updated subscription. + content: + application/json: + schema: + $ref: ../schemas/Subscription.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: + - sp:trigger-service-subscriptions:manage +delete: + operationId: deleteSubscription + tags: + - Triggers + summary: Delete a Subscription + description: Deletes an existing subscription to a trigger. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSubscriptions + description: Subscription ID + example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '204': + $ref: ../responses/204.yaml + description: Subscription is deleted successfully. + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: + - sp:trigger-service-subscriptions:manage diff --git a/static/api-specs/idn/v2025/paths/trigger-subscriptions-internal.yaml b/static/api-specs/idn/v2025/paths/trigger-subscriptions-internal.yaml new file mode 100644 index 000000000..48d4acbf3 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/trigger-subscriptions-internal.yaml @@ -0,0 +1,34 @@ +post: + operationId: createSubscription + tags: + - Triggers + summary: Creates Subscription (Internal) + description: >- + This creates a subscription for a trigger which defines the way the trigger is invoked. + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/SubscriptionInternal.yaml' + responses: + '201': + description: >- + Created subscription object. The trigger can then be invoked by the method defined in the subscription. + content: + application/json: + schema: + $ref: '../schemas/SubscriptionInternal.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + + security: + - userAuth: [sp:trigger-service-subscriptions:manage] diff --git a/static/api-specs/idn/v2025/paths/trigger-subscriptions-validate-filter.yaml b/static/api-specs/idn/v2025/paths/trigger-subscriptions-validate-filter.yaml new file mode 100644 index 000000000..09c0e9744 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/trigger-subscriptions-validate-filter.yaml @@ -0,0 +1,55 @@ +post: + operationId: testSubscriptionFilter + tags: + - Triggers + summary: Validate a Subscription Filter + description: 'Validates a JSONPath filter expression against a provided mock input. + + Request requires a security scope of: ' + requestBody: + required: true + content: + application/json: + schema: + $ref: ../schemas/ValidateFilterInputDto.yaml + required: + - input + - filter + example: + input: + identityId: 201327fda1c44704ac01181e963d463c + filter: $[?($.identityId == "201327fda1c44704ac01181e963d463c")] + responses: + '200': + description: Boolean whether specified filter expression is valid against the + input. + content: + application/json: + schema: + $ref: ../schemas/ValidateFilterOutputDto.yaml + example: + isValid: true + isValidJSONPath: true + isPathExist: true + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: + - sp:trigger-service-subscriptions:manage + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true diff --git a/static/api-specs/idn/v2025/paths/trigger-subscriptions.yaml b/static/api-specs/idn/v2025/paths/trigger-subscriptions.yaml new file mode 100644 index 000000000..4a47c2081 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/trigger-subscriptions.yaml @@ -0,0 +1,211 @@ +post: + operationId: createSubscription + tags: + - Triggers + summary: Create a Subscription + description: 'This API creates a new subscription to a trigger and defines trigger + invocation details. The type of subscription determines which config object is + required: + + * HTTP subscriptions require httpConfig + + * EventBridge subscriptions require eventBridgeConfig' + requestBody: + required: true + content: + application/json: + schema: + $ref: ../schemas/SubscriptionPostRequest.yaml + examples: + HTTP Subscription: + value: + name: Access request subscription + description: Access requested to site xyz + triggerId: idn:access-requested + type: HTTP + httpConfig: + url: https://www.example.com + httpDispatchMode: SYNC + httpAuthenticationType: BASIC_AUTH + basicAuthConfig: + userName: user@example.com + password: eRtg4%6yuI! + enabled: true + filter: $[?($.identityId == "201327fda1c44704ac01181e963d463c")] + HTTP Async Subscription: + value: + name: Access request subscription + description: Access requested to site xyz + triggerId: idn:access-requested + type: HTTP + responseDeadline: PT1H + httpConfig: + url: https://www.example.com + httpDispatchMode: ASYNC + httpAuthenticationType: BASIC_AUTH + basicAuthConfig: + userName: user@example.com + password: eRtg4%6yuI! + enabled: true + filter: $[?($.identityId == "201327fda1c44704ac01181e963d463c")] + EventBridge Subscription: + value: + name: Access request subscription + description: Access requested to site xyz + triggerId: idn:access-requested + type: EVENTBRIDGE + eventBridgeConfig: + awsAccount: '123456789012' + awsRegion: us-west-1 + enabled: true + filter: $[?($.identityId == "201327fda1c44704ac01181e963d463c")] + responses: + '201': + description: New subscription to a trigger. The trigger can now be invoked by + the method defined in the subscription. + content: + application/json: + schema: + $ref: ../schemas/Subscription.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: + - sp:trigger-service-subscriptions:manage + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true +get: + operationId: listSubscriptions + tags: + - Triggers + summary: List Subscriptions + description: Gets a list of all trigger subscriptions. + parameters: + - $ref: ../parameters/limit.yaml + - $ref: ../parameters/offset.yaml + - $ref: ../parameters/count.yaml + - in: query + required: false + name: filters + schema: + type: string + description: 'Filter results using the standard syntax described in [V3 API Standard + Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) + + + Filtering is supported for the following fields and operators: + + + **id**: *eq* + + + **triggerId**: *eq* + + + **type**: *eq, le*' + example: id eq "12cff757-c0c0-413b-8ad7-2a47956d1e89" + - in: query + name: sorters + required: false + schema: + type: string + format: comma-separated + description: 'Sort results using the standard syntax described in [V3 API Standard + Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **triggerId, triggerName**' + example: triggerName + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: List of subscriptions. + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/Subscription.yaml + examples: + HTTP Subscription: + value: + - id: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + name: Access request subscription + description: Access requested to site xyz + triggerId: idn:access-requested + triggerName: Access Requested + type: HTTP + httpConfig: + url: https://www.example.com + httpDispatchMode: SYNC + httpAuthenticationType: BASIC_AUTH + basicAuthConfig: + userName: user@example.com + password: null + enabled: true + filter: $[?($.identityId == "201327fda1c44704ac01181e963d463c")] + HTTP Async Subscription: + value: + name: Access request subscription + description: Access requested to site xyz + triggerId: idn:access-requested + triggerName: Access Requested + type: HTTP + responseDeadline: PT1H + httpConfig: + url: https://www.example.com + httpDispatchMode: ASYNC + httpAuthenticationType: BASIC_AUTH + basicAuthConfig: + userName: user@example.com + password: null + enabled: true + filter: $[?($.identityId == "201327fda1c44704ac01181e963d463c")] + EventBridge Subscription: + value: + - id: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + name: Access request subscription + description: Access requested to site xyz + triggerId: idn:access-requested + triggerName: Access Requested + type: EVENTBRIDGE + eventBridgeConfig: + awsAccount: '123456789012' + awsRegion: us-west-1 + enabled: true + filter: $[?($.identityId == "201327fda1c44704ac01181e963d463c")] + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: + - sp:trigger-service-subscriptions:read diff --git a/static/api-specs/idn/v2025/paths/triggers.yaml b/static/api-specs/idn/v2025/paths/triggers.yaml new file mode 100644 index 000000000..49d3fa59b --- /dev/null +++ b/static/api-specs/idn/v2025/paths/triggers.yaml @@ -0,0 +1,66 @@ +get: + operationId: listTriggers + tags: + - Triggers + summary: List Triggers + description: Gets a list of triggers that are available in the tenant. + parameters: + - $ref: ../parameters/limit.yaml + - $ref: ../parameters/offset.yaml + - $ref: ../parameters/count.yaml + - in: query + name: filters + required: false + schema: + type: string + description: 'Filter results using the standard syntax described in [V3 API Standard + Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) + + + Filtering is supported for the following fields and operators: + + + **id**: *eq, ge, le*' + example: id eq "idn:access-request-post-approval" + - in: query + name: sorters + required: false + schema: + type: string + format: comma-separated + description: 'Sort results using the standard syntax described in [V3 API Standard + Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **id, name**' + example: name + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: List of triggers. + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/Trigger.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + security: + - userAuth: + - sp:trigger-service-subscriptions:read diff --git a/static/api-specs/idn/v2025/paths/ui-metadata/tenant-ui-metadata.yaml b/static/api-specs/idn/v2025/paths/ui-metadata/tenant-ui-metadata.yaml new file mode 100644 index 000000000..66a0d3773 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/ui-metadata/tenant-ui-metadata.yaml @@ -0,0 +1,86 @@ +get: + operationId: getTenantUiMetadata + tags: + - UI Metadata + summary: Get a tenant UI metadata + description: This API endpoint retrieves UI metadata configured for your tenant. + security: + - userAuth: + - idn:ui-access-metadata-page:read + x-sailpoint-userLevels: + - ORG_ADMIN + responses: + '200': + description: A tenant UI metadata object + content: + application/json: + schema: + $ref: ../../schemas/ui-metadata/TenantUiMetadataItemResponse.yaml + '400': + $ref: ../../responses/400.yaml + '401': + $ref: ../../responses/401.yaml + '403': + $ref: ../../responses/403.yaml + '404': + $ref: ../../responses/404.yaml + '429': + $ref: ../../responses/429.yaml + '500': + $ref: ../../responses/500.yaml + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true +put: + operationId: setTenantUiMetadata + tags: + - UI Metadata + summary: Update tenant UI metadata + description: >- + This API endpoint updates UI metadata for your tenant. These changes + may require up to 5 minutes to take effect on the UI. + requestBody: + required: true + content: + application/json: + schema: + $ref: ../../schemas/ui-metadata/TenantUiMetadataItemUpdateRequest.yaml + security: + - userAuth: + - idn:ui-access-metadata-page:manage + x-sailpoint-userLevels: + - ORG_ADMIN + responses: + '200': + description: A tenant UI metadata object + content: + application/json: + schema: + $ref: ../../schemas/ui-metadata/TenantUiMetadataItemResponse.yaml + '400': + $ref: ../../responses/400.yaml + '401': + $ref: ../../responses/401.yaml + '403': + $ref: ../../responses/403.yaml + '404': + $ref: ../../responses/404.yaml + '429': + $ref: ../../responses/429.yaml + '500': + $ref: ../../responses/500.yaml + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true diff --git a/static/api-specs/idn/v2025/paths/vendor-connector-mappings.yaml b/static/api-specs/idn/v2025/paths/vendor-connector-mappings.yaml new file mode 100644 index 000000000..a2e505243 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/vendor-connector-mappings.yaml @@ -0,0 +1,140 @@ +get: + security: + - userAuth: [idn:application-discovery:read] + operationId: getVendorConnectorMappings + tags: + - Vendor Connector Mappings + summary: List Vendor Connector Mappings + description: > + Get a list of mappings between SaaS vendors and ISC connectors, detailing the connections established for correlation. + responses: + '200': + description: Successfully retrieved list. + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/VendorConnectorMapping.yaml' + example: + - id: "78733556-9ea3-4f59-bf69-e5cd92b011b4" + vendor: "Example Vendor" + connector: "Example Connector" + createdAt: "2024-03-13T12:56:19.391294Z" + createdBy: "admin" + updatedAt: + Time: "2024-03-14T12:56:19.391294Z" + Valid: true + updatedBy: + String: "user-67891" + Valid: true + deletedAt: + Time: "0001-01-01T00:00:00Z" + Valid: false + deletedBy: + String: "" + Valid: false + - id: "78733556-9ea3-4f59-bf69-e5cd92b011b5" + vendor: "Another Corporation" + connector: "Another Connector" + createdAt: "2024-04-13T11:46:19.391294Z" + createdBy: "admin" + updatedAt: + Time: "0001-01-01T00:00:00Z" + Valid: false + updatedBy: + String: "" + Valid: false + deletedAt: + Time: "0001-01-01T00:00:00Z" + Valid: false + deletedBy: + String: "" + Valid: false + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '405': + $ref: '../responses/405.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + +post: + security: + - userAuth: [idn:application-discovery:write] + operationId: createVendorConnectorMapping + tags: + - Vendor Connector Mappings + summary: Create Vendor Connector Mapping + description: > + Create a new mapping between a SaaS vendor and an ISC connector to establish correlation paths. + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/VendorConnectorMapping.yaml' + responses: + '200': + description: Successfully created a new vendor connector mapping. + content: + application/json: + schema: + $ref: '../schemas/VendorConnectorMapping.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '405': + $ref: '../responses/405.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + +delete: + security: + - userAuth: [idn:application-discovery:write] + operationId: deleteVendorConnectorMapping + tags: + - Vendor Connector Mappings + summary: Delete Vendor Connector Mapping + description: > + Soft delete a mapping between a SaaS vendor and an ISC connector, removing the established correlation. + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/VendorConnectorMapping.yaml' + responses: + '200': + description: Successfully deleted the specified vendor connector mapping. + content: + application/json: + schema: + type: object + properties: + count: + type: integer + description: The number of vendor connector mappings successfully deleted. + example: 1 + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/verified-domains.yaml b/static/api-specs/idn/v2025/paths/verified-domains.yaml new file mode 100644 index 000000000..34dee3dbf --- /dev/null +++ b/static/api-specs/idn/v2025/paths/verified-domains.yaml @@ -0,0 +1,81 @@ +get: + security: + - userAuth: + - sp:notification-dkim-attributes:read + operationId: getDkimAttributes + tags: + - Notifications + summary: Get DKIM Attributes + description: Retrieve DKIM (DomainKeys Identified Mail) attributes for all your + tenants' AWS SES identities. Limits retrieval to 100 identities per call. + responses: + '200': + description: List of DKIM Attributes + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/DkimAttributes.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true +post: + security: + - userAuth: + - sp:notification-verify-domain-dkim:write + operationId: createDomainDkim + tags: + - Notifications + summary: Verify domain address via DKIM + description: Create a domain to be verified via DKIM (DomainKeys Identified Mail) + requestBody: + required: true + content: + application/json: + schema: + $ref: ../schemas/DomainAddress.yaml + responses: + '200': + description: List of DKIM tokens required for the verification process. + content: + application/json: + schema: + $ref: ../schemas/DomainStatusDto.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '405': + $ref: ../responses/405.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true diff --git a/static/api-specs/idn/v2025/paths/verified-from-address.yaml b/static/api-specs/idn/v2025/paths/verified-from-address.yaml new file mode 100644 index 000000000..8f5c954eb --- /dev/null +++ b/static/api-specs/idn/v2025/paths/verified-from-address.yaml @@ -0,0 +1,36 @@ +delete: + operationId: deleteVerifiedFromAddress + tags: + - Notifications + summary: Delete Verified From Address + description: Delete a verified sender email address + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listFromAddresses + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '204': + $ref: ../responses/204.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/verified-from-addresses.yaml b/static/api-specs/idn/v2025/paths/verified-from-addresses.yaml new file mode 100644 index 000000000..4c0745234 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/verified-from-addresses.yaml @@ -0,0 +1,99 @@ +get: + operationId: listFromAddresses + tags: + - Notifications + summary: List From Addresses + description: Retrieve a list of sender email addresses and their verification statuses + parameters: + - $ref: ../parameters/limit.yaml + - $ref: ../parameters/offset.yaml + - $ref: ../parameters/count.yaml + - in: query + name: filters + schema: + type: string + description: '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: + + + **email**: *eq, ge, le, sw*' + example: email eq "john.doe@company.com" + - in: query + name: sorters + schema: + type: string + format: comma-separated + description: 'Sort results using the standard syntax described in [V3 API Standard + Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **email**' + example: email + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: List of Email Status + content: + application/json: + schema: + type: array + items: + $ref: ../schemas/EmailStatusDto.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml +post: + operationId: createVerifiedFromAddress + tags: + - Notifications + summary: Create Verified From Address + description: Create a new sender email address and initiate verification process. + requestBody: + required: true + content: + application/json: + schema: + $ref: ../schemas/EmailStatusDto.yaml + example: + email: sender@example.com + responses: + '201': + description: New Verified Email Status + content: + application/json: + schema: + $ref: ../schemas/EmailStatusDto.yaml + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true diff --git a/static/api-specs/idn/v2025/paths/work-item-forward.yaml b/static/api-specs/idn/v2025/paths/work-item-forward.yaml new file mode 100644 index 000000000..b23e1fe0d --- /dev/null +++ b/static/api-specs/idn/v2025/paths/work-item-forward.yaml @@ -0,0 +1,43 @@ +post: + operationId: forwardWorkItem + tags: + - Work Items + summary: Forward a Work Item + description: This API forwards a work item to a new owner. Either an admin, or the + owning/current user must make this request. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listWorkItems + description: The ID of the work item + example: ef38f94347e94562b5bb8424a56397d8 + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + requestBody: + required: true + content: + application/json: + schema: + $ref: ../schemas/WorkItemForward.yaml + responses: + '200': + description: Success, but no data is returned. + '400': + $ref: ../responses/400.yaml + '401': + $ref: ../responses/401.yaml + '403': + $ref: ../responses/403.yaml + '429': + $ref: ../responses/429.yaml + '500': + $ref: ../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/work-item.yaml b/static/api-specs/idn/v2025/paths/work-item.yaml new file mode 100644 index 000000000..066fd3b94 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/work-item.yaml @@ -0,0 +1,75 @@ +get: + operationId: getWorkItem + tags: + - Work Items + summary: Get a Work Item + description: >- + This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listWorkItems + description: ID of the work item. + example: 2c9180835d191a86015d28455b4a2329 + responses: + '200': + description: The work item with the given ID. + content: + application/json: + schema: + $ref: '../schemas/WorkItems.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +post: + operationId: completeWorkItem + tags: + - Work Items + summary: Complete a Work Item + description: >- + This API completes a work item. Either an admin, or the owning/current user must make this request. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listWorkItems + description: The ID of the work item + example: ef38f94347e94562b5bb8424a56397d8 + requestBody: + description: Body is the request payload to create form definition request + content: + application/json: + schema: + type: "string" + nullable: true + responses: + '200': + description: A WorkItems object + content: + application/json: + schema: + $ref: '../schemas/WorkItems.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/work-items-account-selection.yaml b/static/api-specs/idn/v2025/paths/work-items-account-selection.yaml new file mode 100644 index 000000000..ad141eda1 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/work-items-account-selection.yaml @@ -0,0 +1,45 @@ +post: + operationId: submitAccountSelection + tags: + - Work Items + summary: Submit Account Selections + description: >- + This API submits account selections. Either an admin, or the owning/current user must make this request. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listWorkItems + description: The ID of the work item + example: ef38f94347e94562b5bb8424a56397d8 + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: true + example: { "fieldName": "fieldValue"} + description: Account Selection Data map, keyed on fieldName + + responses: + '200': + description: A work items details object. + content: + application/json: + schema: + $ref: '../schemas/WorkItems.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/work-items-approve-approval-item.yaml b/static/api-specs/idn/v2025/paths/work-items-approve-approval-item.yaml new file mode 100644 index 000000000..27ab9e360 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/work-items-approve-approval-item.yaml @@ -0,0 +1,42 @@ +post: + operationId: approveApprovalItem + tags: + - Work Items + summary: Approve an Approval Item + description: >- + This API approves an Approval Item. Either an admin, or the owning/current user must make this request. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listWorkItems + description: The ID of the work item + example: ef38f94347e94562b5bb8424a56397d8 + - in: path + name: approvalItemId + schema: + type: string + required: true + description: The ID of the approval item. + example: 1211bcaa32112bcef6122adb21cef1ac + responses: + '200': + description: A work items details object. + content: + application/json: + schema: + $ref: '../schemas/WorkItems.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/work-items-bulk-approve-approval-item.yaml b/static/api-specs/idn/v2025/paths/work-items-bulk-approve-approval-item.yaml new file mode 100644 index 000000000..29b7ebbc3 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/work-items-bulk-approve-approval-item.yaml @@ -0,0 +1,35 @@ +post: + operationId: approveApprovalItemsInBulk + tags: + - Work Items + summary: Bulk approve Approval Items + description: >- + This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listWorkItems + description: The ID of the work item + example: ef38f94347e94562b5bb8424a56397d8 + responses: + '200': + description: A work items details object. + content: + application/json: + schema: + $ref: '../schemas/WorkItems.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/work-items-bulk-reject-approval-item.yaml b/static/api-specs/idn/v2025/paths/work-items-bulk-reject-approval-item.yaml new file mode 100644 index 000000000..28ee8d0a8 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/work-items-bulk-reject-approval-item.yaml @@ -0,0 +1,35 @@ +post: + operationId: rejectApprovalItemsInBulk + tags: + - Work Items + summary: Bulk reject Approval Items + description: >- + This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listWorkItems + description: The ID of the work item + example: ef38f94347e94562b5bb8424a56397d8 + responses: + '200': + description: A work items details object. + content: + application/json: + schema: + $ref: '../schemas/WorkItems.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/work-items-complete.yaml b/static/api-specs/idn/v2025/paths/work-items-complete.yaml new file mode 100644 index 000000000..98b416de2 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/work-items-complete.yaml @@ -0,0 +1,29 @@ +post: + operationId: completeWorkItem + tags: + - Work Items + summary: Complete a Work Item + description: >- + This API completes a work item. Either an admin, or the owning/current user must make this request. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listWorkItems + description: The ID of the work item + example: ef38f94347e94562b5bb8424a56397d8 + responses: + '200': + description: An identity campaign certification object + content: + application/json: + schema: + $ref: '../schemas/WorkItems.yaml' + '400': + $ref: '../responses/400.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' diff --git a/static/api-specs/idn/v2025/paths/work-items-completed-count.yaml b/static/api-specs/idn/v2025/paths/work-items-completed-count.yaml new file mode 100644 index 000000000..23485f8fa --- /dev/null +++ b/static/api-specs/idn/v2025/paths/work-items-completed-count.yaml @@ -0,0 +1,35 @@ +get: + operationId: getCountCompletedWorkItems + tags: + - Work Items + summary: Count Completed Work Items + description: This gets a count of completed work items belonging to either the specified + user(admin required), or the current user. + parameters: + - in: query + name: ownerId + schema: + type: string + description: ID of the work item owner. + required: false + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: List of work items + content: + application/json: + schema: + $ref: ../schemas/WorkItemsCount.yaml + '400': + $ref: ../responses/400.yaml + '403': + $ref: ../responses/403.yaml + '404': + $ref: ../responses/404.yaml diff --git a/static/api-specs/idn/v2025/paths/work-items-completed.yaml b/static/api-specs/idn/v2025/paths/work-items-completed.yaml new file mode 100644 index 000000000..3c7c2c495 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/work-items-completed.yaml @@ -0,0 +1,40 @@ +get: + operationId: getCompletedWorkItems + tags: + - Work Items + summary: Completed Work Items + description: >- + This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. + parameters: + - in: query + name: ownerId + schema: + type: string + description: >- + The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. + required: false + example: 1211bcaa32112bcef6122adb21cef1ac + - $ref: '../parameters/limit.yaml' + - $ref: '../parameters/offset.yaml' + - $ref: '../parameters/count.yaml' + responses: + '200': + description: List of completed work items. + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/WorkItems.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + + diff --git a/static/api-specs/idn/v2025/paths/work-items-count.yaml b/static/api-specs/idn/v2025/paths/work-items-count.yaml new file mode 100644 index 000000000..b7d7779e3 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/work-items-count.yaml @@ -0,0 +1,34 @@ +get: + operationId: getCountWorkItems + tags: + - Work Items + summary: Count Work Items + description: >- + This gets a count of work items belonging to either the specified user(admin required), or the current user. + parameters: + - in: query + name: ownerId + schema: + type: string + description: ID of the work item owner. + required: false + example: ef38f94347e94562b5bb8424a56397d8 + responses: + '200': + description: List of work items + content: + application/json: + schema: + $ref: '../schemas/WorkItemsCount.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + + diff --git a/static/api-specs/idn/v2025/paths/work-items-reject-approval-item.yaml b/static/api-specs/idn/v2025/paths/work-items-reject-approval-item.yaml new file mode 100644 index 000000000..c35bb2248 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/work-items-reject-approval-item.yaml @@ -0,0 +1,42 @@ +post: + operationId: rejectApprovalItem + tags: + - Work Items + summary: Reject an Approval Item + description: >- + This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listWorkItems + description: The ID of the work item + example: ef38f94347e94562b5bb8424a56397d8 + - in: path + name: approvalItemId + schema: + type: string + required: true + description: The ID of the approval item. + example: 1211bcaa32112bcef6122adb21cef1ac + responses: + '200': + description: A work items details object. + content: + application/json: + schema: + $ref: '../schemas/WorkItems.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/work-items-summary.yaml b/static/api-specs/idn/v2025/paths/work-items-summary.yaml new file mode 100644 index 000000000..af6d1ce13 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/work-items-summary.yaml @@ -0,0 +1,34 @@ +get: + operationId: getWorkItemsSummary + tags: + - Work Items + summary: Work Items Summary + description: >- + This gets a summary of work items belonging to either the specified user(admin required), or the current user. + parameters: + - in: query + name: ownerId + schema: + type: string + description: ID of the work item owner. + required: false + example: 1211bcaa32112bcef6122adb21cef1ac + responses: + '200': + description: List of work items + content: + application/json: + schema: + $ref: '../schemas/WorkItemsSummary.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + + diff --git a/static/api-specs/idn/v2025/paths/work-items.yaml b/static/api-specs/idn/v2025/paths/work-items.yaml new file mode 100644 index 000000000..e9b9a2aea --- /dev/null +++ b/static/api-specs/idn/v2025/paths/work-items.yaml @@ -0,0 +1,39 @@ +get: + operationId: listWorkItems + tags: + - Work Items + summary: List Work Items + description: >- + This gets a collection of work items belonging to either the specified user(admin required), or the current user. + parameters: + - $ref: '../parameters/limit.yaml' + - $ref: '../parameters/offset.yaml' + - $ref: '../parameters/count.yaml' + - in: query + name: ownerId + schema: + type: string + description: ID of the work item owner. + required: false + example: 1211bcaa32112bcef6122adb21cef1ac + responses: + '200': + description: List of work items + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/WorkItems.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' + + diff --git a/static/api-specs/idn/v2025/paths/workflow-execution-cancel.yaml b/static/api-specs/idn/v2025/paths/workflow-execution-cancel.yaml new file mode 100644 index 000000000..7362bbb47 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/workflow-execution-cancel.yaml @@ -0,0 +1,35 @@ +post: + operationId: cancelWorkflowExecution + tags: + - Workflows + summary: Cancel Workflow Execution by ID + description: >- + Use this API to cancel a running workflow execution. + security: + - userAuth: [sp:workflow-execute:external] + parameters: + - name: id + in: path + description: The workflow execution ID + required: true + x-sailpoint-resource-operation-id: getWorkflowExecutions + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + responses: + '204': + $ref: '../responses/204.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/workflow-execution-history.yaml b/static/api-specs/idn/v2025/paths/workflow-execution-history.yaml new file mode 100644 index 000000000..fae0765e5 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/workflow-execution-history.yaml @@ -0,0 +1,42 @@ +get: + operationId: getWorkflowExecutionHistory + tags: + - Workflows + summary: Get Workflow Execution History + description: >- + Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. + security: + - userAuth: [sp:workflow:read] + parameters: + - name: id + in: path + description: Id of the workflow execution + required: true + x-sailpoint-resource-operation-id: getWorkflowExecutions + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + responses: + '200': + description: >- + List of workflow execution events for the given workflow execution + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/WorkflowExecutionEvent.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/workflow-execution.yaml b/static/api-specs/idn/v2025/paths/workflow-execution.yaml new file mode 100644 index 000000000..ea73228d7 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/workflow-execution.yaml @@ -0,0 +1,41 @@ +get: + operationId: getWorkflowExecution + tags: + - Workflows + summary: Get Workflow Execution + description: >- + Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. + security: + - userAuth: [sp:workflow:read] + parameters: + - name: id + in: path + description: Workflow execution ID. + required: true + x-sailpoint-resource-operation-id: listWorkflows + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + responses: + '200': + description: >- + Workflow execution. + content: + application/json: + schema: + items: + $ref: '../schemas/WorkflowExecution.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/workflow-executions.yaml b/static/api-specs/idn/v2025/paths/workflow-executions.yaml new file mode 100644 index 000000000..a8552e45b --- /dev/null +++ b/static/api-specs/idn/v2025/paths/workflow-executions.yaml @@ -0,0 +1,80 @@ +get: + operationId: getWorkflowExecutions + tags: + - Workflows + summary: List Workflow Executions + description: >- + Use this API to list a specified workflow's executions. Workflow executions are available for up to 90 days before being archived. + By default, you can get a maximum of 250 executions. + To get executions past the first 250 records, you can do the following: + + 1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. + + 2. Get your workflow ID from the response. + + 3. You can then do either of the following: + + - Filter to find relevant workflow executions. + For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq "Failed"` + + - Paginate through results with the `offset` parameter. + For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. + Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. + security: + - userAuth: [sp:workflow:read] + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + parameters: + - name: id + in: path + description: Workflow ID. + required: true + x-sailpoint-resource-operation-id: listWorkflows + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + - $ref: "../parameters/limit.yaml" + - $ref: "../parameters/offset.yaml" + - $ref: "../parameters/count.yaml" + - in: query + name: filters + schema: + type: string + example: status eq "Failed" + description: >- + 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: + + + **startTime**: *eq, lt, le, gt, ge* + + + **status**: *eq* + required: false + responses: + '200': + description: >- + List of workflow executions for the specified workflow. + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/WorkflowExecution.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '404': + $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/workflow-external-execute-test.yaml b/static/api-specs/idn/v2025/paths/workflow-external-execute-test.yaml new file mode 100644 index 000000000..b8ae5656e --- /dev/null +++ b/static/api-specs/idn/v2025/paths/workflow-external-execute-test.yaml @@ -0,0 +1,57 @@ +post: + operationId: testExternalExecuteWorkflow + tags: + - Workflows + summary: Test Workflow via External Trigger + description: >- + Validate a workflow with an "External Trigger" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. + security: + - userAuth: [sp:workflow-execute:external] + parameters: + - name: id + in: path + description: Id of the workflow + required: true + x-sailpoint-resource-operation-id: listWorkflows + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + input: + type: object + description: The test input for the workflow + example: { + "test": "hello world" + } + responses: + '200': + description: Responds with the test input + content: + application/json: + schema: + type: object + properties: + payload: + type: object + description: The input that was received + example: { + "test": "hello world" + } + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/workflow-external-execute.yaml b/static/api-specs/idn/v2025/paths/workflow-external-execute.yaml new file mode 100644 index 000000000..bdaf308bb --- /dev/null +++ b/static/api-specs/idn/v2025/paths/workflow-external-execute.yaml @@ -0,0 +1,61 @@ +post: + operationId: postExternalExecuteWorkflow + tags: + - Workflows + summary: Execute Workflow via External Trigger + description: >- + This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the "External Trigger" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. + security: + - userAuth: [sp:workflow-execute:external] + parameters: + - name: id + in: path + description: Id of the workflow + required: true + x-sailpoint-resource-operation-id: listWorkflows + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + input: + type: object + description: The input for the workflow + example: { + "customAttribute1": "value1", + "customAttribute2": "value2" + } + responses: + '200': + description: The Workflow object + content: + application/json: + schema: + type: object + properties: + workflowExecutionId: + type: string + description: The workflow execution id + example: 0e11cefa-96e7-4b67-90d0-065bc1da5753 + message: + type: string + description: An error message if any errors occurred + example: Workflow was not executed externally. Check enabled flag on workflow definition + + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/workflow-external-oauth-client.yaml b/static/api-specs/idn/v2025/paths/workflow-external-oauth-client.yaml new file mode 100644 index 000000000..6fc7e6fde --- /dev/null +++ b/static/api-specs/idn/v2025/paths/workflow-external-oauth-client.yaml @@ -0,0 +1,37 @@ +post: + operationId: postWorkflowExternalTrigger + tags: + - Workflows + summary: Generate External Trigger OAuth Client + description: >- + Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. + security: + - userAuth: [sp:workflow:manage] + parameters: + - name: id + in: path + description: Id of the workflow + required: true + x-sailpoint-resource-operation-id: listWorkflows + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + responses: + '200': + description: The OAuth Client object + content: + application/json: + schema: + $ref: '../schemas/WorkflowOAuthClient.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/workflow-library-actions.yaml b/static/api-specs/idn/v2025/paths/workflow-library-actions.yaml new file mode 100644 index 000000000..ca4e8b2fb --- /dev/null +++ b/static/api-specs/idn/v2025/paths/workflow-library-actions.yaml @@ -0,0 +1,49 @@ +get: + operationId: listWorkflowLibraryActions + tags: + - Workflows + summary: List Workflow Library Actions + description: >- + This lists the workflow actions available to you. + externalDocs: + description: Additional documentation for each action + url: https://documentation.sailpoint.com/saas/help/workflows/workflow-steps.html#actions + parameters: + - $ref: '../parameters/limit.yaml' + - $ref: '../parameters/offset.yaml' + - in: query + name: filters + required: false + schema: + type: string + description: >- + Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) + + + Filtering is supported for the following fields and operators: + + + **id**: *eq* + example: id eq "sp:create-campaign" + security: + - userAuth: [sp:workflow:read] + responses: + '200': + description: >- + List of workflow actions + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/WorkflowLibraryAction.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/workflow-library-operators.yaml b/static/api-specs/idn/v2025/paths/workflow-library-operators.yaml new file mode 100644 index 000000000..9fdf1a1c0 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/workflow-library-operators.yaml @@ -0,0 +1,29 @@ +get: + operationId: listWorkflowLibraryOperators + tags: + - Workflows + summary: List Workflow Library Operators + description: >- + This lists the workflow operators available to you + security: + - userAuth: [sp:workflow:read] + responses: + '200': + description: >- + List of workflow operators + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/WorkflowLibraryOperator.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/workflow-library-triggers.yaml b/static/api-specs/idn/v2025/paths/workflow-library-triggers.yaml new file mode 100644 index 000000000..542b423cc --- /dev/null +++ b/static/api-specs/idn/v2025/paths/workflow-library-triggers.yaml @@ -0,0 +1,49 @@ +get: + operationId: listWorkflowLibraryTriggers + tags: + - Workflows + summary: List Workflow Library Triggers + description: >- + This lists the workflow triggers available to you + externalDocs: + description: Additional documentation for each trigger + url: https://documentation.sailpoint.com/saas/help/workflows/workflow-steps.html#triggers + parameters: + - $ref: '../parameters/limit.yaml' + - $ref: '../parameters/offset.yaml' + - in: query + name: filters + required: false + schema: + type: string + description: >- + Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) + + + Filtering is supported for the following fields and operators: + + + **id**: *eq* + example: id eq "idn:identity-attributes-changed" + security: + - userAuth: [sp:workflow:read] + responses: + '200': + description: >- + List of workflow triggers + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/WorkflowLibraryTrigger.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/workflow-library.yaml b/static/api-specs/idn/v2025/paths/workflow-library.yaml new file mode 100644 index 000000000..afd8c5d40 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/workflow-library.yaml @@ -0,0 +1,38 @@ +get: + operationId: listCompleteWorkflowLibrary + tags: + - Workflows + summary: List Complete Workflow Library + description: >- + This lists all triggers, actions, and operators in the library + externalDocs: + description: Additional documentation for workflows + url: https://documentation.sailpoint.com/saas/help/workflows/workflow-steps.html + parameters: + - $ref: '../parameters/limit.yaml' + - $ref: '../parameters/offset.yaml' + security: + - userAuth: [sp:workflow:read] + responses: + '200': + description: >- + List of workflow steps + content: + application/json: + schema: + type: array + items: + anyOf: + - $ref: '../schemas/WorkflowLibraryAction.yaml' + - $ref: '../schemas/WorkflowLibraryTrigger.yaml' + - $ref: '../schemas/WorkflowLibraryOperator.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/workflow-test.yaml b/static/api-specs/idn/v2025/paths/workflow-test.yaml new file mode 100644 index 000000000..e37d78b00 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/workflow-test.yaml @@ -0,0 +1,97 @@ +post: + operationId: testWorkflow + tags: + - Workflows + summary: Test Workflow By Id + description: >- + Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/idn/docs/event-triggers/available) for an example input for the trigger that initiates this workflow. + + This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. + + **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** + security: + - userAuth: [sp:workflow-execute:external] + parameters: + - name: id + in: path + description: Id of the workflow + required: true + x-sailpoint-resource-operation-id: listWorkflows + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - input + properties: + input: + type: object + description: The test input for the workflow. + examples: + Identity Attributes Changed: + description: Identity Attributes Changed Trigger Input + value: + { + "input": { + "identity": { + "id": "ee769173319b41d19ccec6cea52f237b", + "name": "john.doe", + "type": "IDENTITY" + }, + "changes": [ + { + "attribute": "department", + "oldValue": "sales", + "newValue": "marketing" + }, + { + "attribute": "manager", + "oldValue": { + "id": "ee769173319b41d19ccec6c235423237b", + "name": "nice.guy", + "type": "IDENTITY" + }, + "newValue": { + "id": "ee769173319b41d19ccec6c235423236c", + "name": "mean.guy", + "type": "IDENTITY" + } + }, + { + "attribute": "email", + "oldValue": "john.doe@hotmail.com", + "newValue": "john.doe@gmail.com" + } + ] + } + } + + responses: + '200': + description: The Workflow object + content: + application/json: + schema: + type: object + properties: + workflowExecutionId: + type: string + description: The workflow execution id + example: "0e11cefa-96e7-4b67-90d0-065bc1da5753" + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/workflow.yaml b/static/api-specs/idn/v2025/paths/workflow.yaml new file mode 100644 index 000000000..2f835308f --- /dev/null +++ b/static/api-specs/idn/v2025/paths/workflow.yaml @@ -0,0 +1,224 @@ +get: + operationId: getWorkflow + tags: + - Workflows + summary: Get Workflow By Id + description: >- + Get a single workflow by id. + security: + - userAuth: [sp:workflow:read] + parameters: + - name: id + in: path + description: Id of the workflow + required: true + x-sailpoint-resource-operation-id: listWorkflows + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + responses: + '200': + description: >- + The workflow object + content: + application/json: + schema: + $ref: '../schemas/Workflow.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +put: + operationId: updateWorkflow + tags: + - Workflows + summary: Update Workflow + description: >- + Perform a full update of a workflow. The updated workflow object is returned in the response. + security: + - userAuth: [sp:workflow:manage] + parameters: + - name: id + in: path + description: Id of the Workflow + required: true + x-sailpoint-resource-operation-id: listWorkflows + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/WorkflowBody.yaml' + responses: + '200': + description: The Workflow object + content: + application/json: + schema: + $ref: '../schemas/Workflow.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +patch: + operationId: patchWorkflow + tags: + - Workflows + summary: Patch Workflow + description: >- + Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + security: + - userAuth: [sp:workflow:manage] + parameters: + - name: id + in: path + description: Id of the Workflow + required: true + x-sailpoint-resource-operation-id: listWorkflows + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + requestBody: + required: true + content: + application/json-patch+json: + schema: + type: array + items: + $ref: '../schemas/JsonPatchOperation.yaml' + examples: + Update all patchable fields: + description: Demonstrate how to update each patchable field in one PATCH request. + value: + [ + { + "op": "replace", + "path": "/name", + "value": "Send Email" + }, + { + "op": "replace", + "path": "/owner", + "value": { + "type": "IDENTITY", + "id": "2c91808568c529c60168cca6f90c1313", + "name": "William Wilson" + + } + }, + { + "op": "replace", + "path": "/description", + "value": "Send an email to the identity who's attributes changed." + }, + { + "op": "replace", + "path": "/enabled", + "value": false + }, + { + "op": "replace", + "path": "/definition", + "value": { + "start": "Send Email Test", + "steps": { + "Send Email": { + "actionId": "sp:send-email", + "attributes": { + "body": "This is a test", + "from": "sailpoint@sailpoint.com", + "recipientId.$": "$.identity.id", + "subject": "test" + }, + "nextStep": "success", + "selectResult": null, + "type": "action" + }, + "success": { + "type": "success" + } + } + } + }, + { + "op": "replace", + "path": "/trigger", + "value": { + "type": "EVENT", + "attributes": { + "id": "idn:identity-attributes-changed" + } + } + } + ] + responses: + '200': + description: The Workflow object + content: + application/json: + schema: + $ref: '../schemas/Workflow.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +delete: + operationId: deleteWorkflow + tags: + - Workflows + summary: Delete Workflow By Id + description: >- + Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. + security: + - userAuth: [sp:workflow:manage] + parameters: + - name: id + in: path + description: Id of the Workflow + required: true + x-sailpoint-resource-operation-id: listWorkflows + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + responses: + '204': + $ref: '../responses/204.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/workflows.yaml b/static/api-specs/idn/v2025/paths/workflows.yaml new file mode 100644 index 000000000..44a0d511a --- /dev/null +++ b/static/api-specs/idn/v2025/paths/workflows.yaml @@ -0,0 +1,164 @@ +post: + operationId: createWorkflow + tags: + - Workflows + summary: Create Workflow + description: >- + Create a new workflow with the desired trigger and steps specified in the request body. + security: + - userAuth: [sp:workflow:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + requestBody: + required: true + content: + application/json: + schema: + allOf: + - required: + - name + - owner + - $ref: '../schemas/WorkflowBody.yaml' + examples: + Event Trigger: + description: Workflow initiated by an event trigger + value: + name: Send Email + owner: + type: IDENTITY + id: 2c91808568c529c60168cca6f90c1313 + name: William Wilson + description: Send an email to the identity who's attributes changed. + definition: + start: Send Email Test + steps: + Send Email: + actionId: sp:send-email + attributes: + body: This is a test + from: sailpoint@sailpoint.com + recipientId.$: "$.identity.id" + subject: test + nextStep: success + selectResult: + type: action + success: + type: success + enabled: false + trigger: + type: EVENT + attributes: + id: idn:identity-attributes-changed + filter: "$.changes[?(@.attribute == 'manager')]" + Scheduled Trigger: + description: Workflow initiated by a scheduled trigger + value: + name: Send Email + owner: + type: IDENTITY + id: 2c91808568c529c60168cca6f90c1313 + name: William Wilson + description: Send an email to the identity who's attributes changed. + definition: + start: Send Email Test + steps: + Send Email: + actionId: sp:send-email + attributes: + body: This is a test + from: sailpoint@sailpoint.com + recipientId.$: "$.identity.id" + subject: test + nextStep: success + selectResult: + type: action + success: + type: success + enabled: false + trigger: + type: SCHEDULED + attributes: + cronString: 0 * */3 */5 * + External Trigger: + description: Workflow initiated by an external trigger + value: + name: Send Email + owner: + type: IDENTITY + id: 2c91808568c529c60168cca6f90c1313 + name: William Wilson + description: Send an email to the identity who's attributes changed. + definition: + start: Send Email Test + steps: + Send Email: + actionId: sp:send-email + attributes: + body: This is a test + from: sailpoint@sailpoint.com + recipientId.$: "$.identity.id" + subject: test + nextStep: success + selectResult: + type: action + success: + type: success + enabled: false + trigger: + type: EXTERNAL + attributes: + name: search-and-notify + description: Run a search and notify the results + responses: + '200': + description: The Workflow object + content: + application/json: + schema: + $ref: '../schemas/Workflow.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' +get: + operationId: listWorkflows + tags: + - Workflows + summary: List Workflows + description: >- + List all workflows in the tenant. + parameters: + - $ref: '../parameters/limit.yaml' + - $ref: '../parameters/offset.yaml' + security: + - userAuth: [sp:workflow:read] + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + responses: + '200': + description: >- + List of workflows + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/Workflow.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/workflows/workflow-execution-cancel.yaml b/static/api-specs/idn/v2025/paths/workflows/workflow-execution-cancel.yaml new file mode 100644 index 000000000..576fbecec --- /dev/null +++ b/static/api-specs/idn/v2025/paths/workflows/workflow-execution-cancel.yaml @@ -0,0 +1,34 @@ +post: + operationId: cancelWorkflowExecution + tags: + - Workflows + summary: Cancel Workflow Execution by ID + description: >- + Use this API to cancel a running workflow execution. + security: + - userAuth: [sp:workflow-execute:external] + parameters: + - name: id + in: path + description: The workflow execution ID + required: true + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + responses: + '204': + $ref: '../../responses/204.yaml' + '400': + $ref: '../../responses/400.yaml' + '401': + $ref: '../../responses/401.yaml' + '403': + $ref: '../../responses/403.yaml' + '404': + $ref: '../../responses/404.yaml' + '429': + $ref: '../../responses/429.yaml' + '500': + $ref: '../../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/workflows/workflow-execution-history.yaml b/static/api-specs/idn/v2025/paths/workflows/workflow-execution-history.yaml new file mode 100644 index 000000000..017c09ce5 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/workflows/workflow-execution-history.yaml @@ -0,0 +1,41 @@ +get: + operationId: getWorkflowExecutionHistory + tags: + - Workflows + summary: Get Workflow Execution History + description: >- + Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. + security: + - userAuth: [sp:workflow:read] + parameters: + - name: id + in: path + description: Id of the workflow execution + required: true + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + responses: + '200': + description: >- + List of workflow execution events for the given workflow execution + content: + application/json: + schema: + type: array + items: + $ref: '../../schemas/workflows/WorkflowExecutionEvent.yaml' + '400': + $ref: '../../responses/400.yaml' + '401': + $ref: '../../responses/401.yaml' + '403': + $ref: '../../responses/403.yaml' + '404': + $ref: '../../responses/404.yaml' + '429': + $ref: '../../responses/429.yaml' + '500': + $ref: '../../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/workflows/workflow-execution.yaml b/static/api-specs/idn/v2025/paths/workflows/workflow-execution.yaml new file mode 100644 index 000000000..a22f58c14 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/workflows/workflow-execution.yaml @@ -0,0 +1,40 @@ +get: + operationId: getWorkflowExecution + tags: + - Workflows + summary: Get Workflow Execution + description: >- + Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. + security: + - userAuth: [sp:workflow:read] + parameters: + - name: id + in: path + description: Workflow execution ID. + required: true + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + responses: + '200': + description: >- + Workflow execution. + content: + application/json: + schema: + items: + $ref: '../../schemas/workflows/WorkflowExecution.yaml' + '400': + $ref: '../../responses/400.yaml' + '401': + $ref: '../../responses/401.yaml' + '403': + $ref: '../../responses/403.yaml' + '404': + $ref: '../../responses/404.yaml' + '429': + $ref: '../../responses/429.yaml' + '500': + $ref: '../../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/workflows/workflow-executions.yaml b/static/api-specs/idn/v2025/paths/workflows/workflow-executions.yaml new file mode 100644 index 000000000..2cb46cc4d --- /dev/null +++ b/static/api-specs/idn/v2025/paths/workflows/workflow-executions.yaml @@ -0,0 +1,76 @@ +get: + operationId: getWorkflowExecutions + tags: + - Workflows + summary: List Workflow Executions + description: >- + Use this API to list a specified workflow's executions. Workflow executions are available for up to 90 days before being archived. + By default, you can get a maximum of 250 executions. + To get executions past the first 250 records, you can do the following: + + 1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. + + 2. Get your workflow ID from the response. + + 3. You can then do either of the following: + + - Filter to find relevant workflow executions. + For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq "Failed"` + + - Paginate through results with the `offset` parameter. + For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. + Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. + security: + - userAuth: [sp:workflow:read] + parameters: + - name: id + in: path + description: Workflow ID. + required: true + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + - $ref: "../../parameters/limit.yaml" + - $ref: "../../parameters/offset.yaml" + - $ref: "../../parameters/count.yaml" + - in: query + name: filters + schema: + type: string + description: >- + 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: + + + **start_time**: *eq, lt, le, gt, ge* + + + **status**: *eq* + example: status eq "Failed" + required: false + responses: + '200': + description: >- + List of workflow executions for the specified workflow. + content: + application/json: + schema: + type: array + items: + $ref: '../../schemas/workflows/WorkflowExecution.yaml' + '400': + $ref: '../../responses/400.yaml' + '401': + $ref: '../../responses/401.yaml' + '403': + $ref: '../../responses/403.yaml' + '404': + $ref: '../../responses/404.yaml' + '429': + $ref: '../../responses/429.yaml' + '500': + $ref: '../../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/workflows/workflow-external-execute-test.yaml b/static/api-specs/idn/v2025/paths/workflows/workflow-external-execute-test.yaml new file mode 100644 index 000000000..04dda2d37 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/workflows/workflow-external-execute-test.yaml @@ -0,0 +1,56 @@ +post: + operationId: testExternalExecuteWorkflow + tags: + - Workflows + summary: Test Workflow via External Trigger + description: >- + Validate a workflow with an "External Trigger" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. + security: + - userAuth: [sp:workflow-execute:external] + parameters: + - name: id + in: path + description: Id of the workflow + required: true + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + input: + type: object + description: The test input for the workflow + example: { + "test": "hello world" + } + responses: + '200': + description: Responds with the test input + content: + application/json: + schema: + type: object + properties: + payload: + type: object + description: The input that was received + example: { + "test": "hello world" + } + '400': + $ref: '../../responses/400.yaml' + '401': + $ref: '../../responses/401.yaml' + '403': + $ref: '../../responses/403.yaml' + '429': + $ref: '../../responses/429.yaml' + '500': + $ref: '../../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/workflows/workflow-external-execute.yaml b/static/api-specs/idn/v2025/paths/workflows/workflow-external-execute.yaml new file mode 100644 index 000000000..79c977a9d --- /dev/null +++ b/static/api-specs/idn/v2025/paths/workflows/workflow-external-execute.yaml @@ -0,0 +1,60 @@ +post: + operationId: createExternalExecuteWorkflow + tags: + - Workflows + summary: Execute Workflow via External Trigger + description: >- + This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the "External Trigger" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. + security: + - userAuth: [sp:workflow-execute:external] + parameters: + - name: id + in: path + description: Id of the workflow + required: true + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + input: + type: object + description: The input for the workflow + example: { + "customAttribute1": "value1", + "customAttribute2": "value2" + } + responses: + '200': + description: The Workflow object + content: + application/json: + schema: + type: object + properties: + workflowExecutionId: + type: string + description: The workflow execution id + example: 0e11cefa-96e7-4b67-90d0-065bc1da5753 + message: + type: string + description: An error message if any errors occurred + example: Workflow was not executed externally. Check enabled flag on workflow definition + + '400': + $ref: '../../responses/400.yaml' + '401': + $ref: '../../responses/401.yaml' + '403': + $ref: '../../responses/403.yaml' + '429': + $ref: '../../responses/429.yaml' + '500': + $ref: '../../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/workflows/workflow-external-oauth-client.yaml b/static/api-specs/idn/v2025/paths/workflows/workflow-external-oauth-client.yaml new file mode 100644 index 000000000..f3897612c --- /dev/null +++ b/static/api-specs/idn/v2025/paths/workflows/workflow-external-oauth-client.yaml @@ -0,0 +1,36 @@ +post: + operationId: createWorkflowExternalTrigger + tags: + - Workflows + summary: Generate External Trigger OAuth Client + description: >- + Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. + security: + - userAuth: [sp:workflow:manage] + parameters: + - name: id + in: path + description: Id of the workflow + required: true + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + responses: + '200': + description: The OAuth Client object + content: + application/json: + schema: + $ref: '../../schemas/workflows/WorkflowOAuthClient.yaml' + '400': + $ref: '../../responses/400.yaml' + '401': + $ref: '../../responses/401.yaml' + '403': + $ref: '../../responses/403.yaml' + '429': + $ref: '../../responses/429.yaml' + '500': + $ref: '../../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/workflows/workflow-library-actions.yaml b/static/api-specs/idn/v2025/paths/workflows/workflow-library-actions.yaml new file mode 100644 index 000000000..5c97e0611 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/workflows/workflow-library-actions.yaml @@ -0,0 +1,49 @@ +get: + operationId: listWorkflowLibraryActions + tags: + - Workflows + summary: List Workflow Library Actions + description: >- + This lists the workflow actions available to you. + externalDocs: + description: Additional documentation for each action + url: https://documentation.sailpoint.com/saas/help/workflows/workflow-steps.html#actions + parameters: + - $ref: '../../parameters/limit.yaml' + - $ref: '../../parameters/offset.yaml' + - in: query + name: filters + required: false + schema: + type: string + description: >- + Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) + + + Filtering is supported for the following fields and operators: + + + **id**: *eq* + example: id eq "sp:create-campaign" + security: + - userAuth: [sp:workflow:read] + responses: + '200': + description: >- + List of workflow actions + content: + application/json: + schema: + type: array + items: + $ref: '../../schemas/workflows/WorkflowLibraryAction.yaml' + '400': + $ref: '../../responses/400.yaml' + '401': + $ref: '../../responses/401.yaml' + '403': + $ref: '../../responses/403.yaml' + '429': + $ref: '../../responses/429.yaml' + '500': + $ref: '../../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/workflows/workflow-library-operators.yaml b/static/api-specs/idn/v2025/paths/workflows/workflow-library-operators.yaml new file mode 100644 index 000000000..b2646cf6d --- /dev/null +++ b/static/api-specs/idn/v2025/paths/workflows/workflow-library-operators.yaml @@ -0,0 +1,29 @@ +get: + operationId: listWorkflowLibraryOperators + tags: + - Workflows + summary: List Workflow Library Operators + description: >- + This lists the workflow operators available to you + security: + - userAuth: [sp:workflow:read] + responses: + '200': + description: >- + List of workflow operators + content: + application/json: + schema: + type: array + items: + $ref: '../../schemas/workflows/WorkflowLibraryOperator.yaml' + '400': + $ref: '../../responses/400.yaml' + '401': + $ref: '../../responses/401.yaml' + '403': + $ref: '../../responses/403.yaml' + '429': + $ref: '../../responses/429.yaml' + '500': + $ref: '../../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/workflows/workflow-library-triggers.yaml b/static/api-specs/idn/v2025/paths/workflows/workflow-library-triggers.yaml new file mode 100644 index 000000000..7be4f4be4 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/workflows/workflow-library-triggers.yaml @@ -0,0 +1,49 @@ +get: + operationId: listWorkflowLibraryTriggers + tags: + - Workflows + summary: List Workflow Library Triggers + description: >- + This lists the workflow triggers available to you + externalDocs: + description: Additional documentation for each trigger + url: https://documentation.sailpoint.com/saas/help/workflows/workflow-steps.html#triggers + parameters: + - $ref: '../../parameters/limit.yaml' + - $ref: '../../parameters/offset.yaml' + - in: query + name: filters + required: false + schema: + type: string + description: >- + Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) + + + Filtering is supported for the following fields and operators: + + + **id**: *eq* + example: id eq "idn:identity-attributes-changed" + security: + - userAuth: [sp:workflow:read] + responses: + '200': + description: >- + List of workflow triggers + content: + application/json: + schema: + type: array + items: + $ref: '../../schemas/workflows/WorkflowLibraryTrigger.yaml' + '400': + $ref: '../../responses/400.yaml' + '401': + $ref: '../../responses/401.yaml' + '403': + $ref: '../../responses/403.yaml' + '429': + $ref: '../../responses/429.yaml' + '500': + $ref: '../../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/workflows/workflow-library.yaml b/static/api-specs/idn/v2025/paths/workflows/workflow-library.yaml new file mode 100644 index 000000000..7da2ae8f0 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/workflows/workflow-library.yaml @@ -0,0 +1,38 @@ +get: + operationId: listCompleteWorkflowLibrary + tags: + - Workflows + summary: List Complete Workflow Library + description: >- + This lists all triggers, actions, and operators in the library + externalDocs: + description: Additional documentation for workflows + url: https://documentation.sailpoint.com/saas/help/workflows/workflow-steps.html + parameters: + - $ref: '../../parameters/limit.yaml' + - $ref: '../../parameters/offset.yaml' + security: + - userAuth: [sp:workflow:read] + responses: + '200': + description: >- + List of workflow steps + content: + application/json: + schema: + type: array + items: + anyOf: + - $ref: '../../schemas/workflows/WorkflowLibraryAction.yaml' + - $ref: '../../schemas/workflows/WorkflowLibraryTrigger.yaml' + - $ref: '../../schemas/workflows/WorkflowLibraryOperator.yaml' + '400': + $ref: '../../responses/400.yaml' + '401': + $ref: '../../responses/401.yaml' + '403': + $ref: '../../responses/403.yaml' + '429': + $ref: '../../responses/429.yaml' + '500': + $ref: '../../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/workflows/workflow-test.yaml b/static/api-specs/idn/v2025/paths/workflows/workflow-test.yaml new file mode 100644 index 000000000..e9b0db0c5 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/workflows/workflow-test.yaml @@ -0,0 +1,96 @@ +post: + operationId: testWorkflow + tags: + - Workflows + summary: Test Workflow By Id + description: >- + Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/idn/docs/event-triggers/available) for an example input for the trigger that initiates this workflow. + + This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. + + **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** + security: + - userAuth: [sp:workflow-execute:external] + parameters: + - name: id + in: path + description: Id of the workflow + required: true + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - input + properties: + input: + type: object + description: The test input for the workflow. + examples: + Identity Attributes Changed: + description: Identity Attributes Changed Trigger Input + value: + { + "input": { + "identity": { + "id": "ee769173319b41d19ccec6cea52f237b", + "name": "john.doe", + "type": "IDENTITY" + }, + "changes": [ + { + "attribute": "department", + "oldValue": "sales", + "newValue": "marketing" + }, + { + "attribute": "manager", + "oldValue": { + "id": "ee769173319b41d19ccec6c235423237b", + "name": "nice.guy", + "type": "IDENTITY" + }, + "newValue": { + "id": "ee769173319b41d19ccec6c235423236c", + "name": "mean.guy", + "type": "IDENTITY" + } + }, + { + "attribute": "email", + "oldValue": "john.doe@hotmail.com", + "newValue": "john.doe@gmail.com" + } + ] + } + } + + responses: + '200': + description: The Workflow object + content: + application/json: + schema: + type: object + properties: + workflowExecutionId: + type: string + description: The workflow execution id + example: "0e11cefa-96e7-4b67-90d0-065bc1da5753" + '400': + $ref: '../../responses/400.yaml' + '401': + $ref: '../../responses/401.yaml' + '403': + $ref: '../../responses/403.yaml' + '429': + $ref: '../../responses/429.yaml' + '500': + $ref: '../../responses/500.yaml' diff --git a/static/api-specs/idn/v2025/paths/workflows/workflow.yaml b/static/api-specs/idn/v2025/paths/workflows/workflow.yaml new file mode 100644 index 000000000..5904119e2 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/workflows/workflow.yaml @@ -0,0 +1,220 @@ +get: + operationId: getWorkflow + tags: + - Workflows + summary: Get Workflow By Id + description: >- + Get a single workflow by id. + security: + - userAuth: [sp:workflow:read] + parameters: + - name: id + in: path + description: Id of the workflow + required: true + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + responses: + '200': + description: >- + The workflow object + content: + application/json: + schema: + $ref: '../../schemas/workflows/Workflow.yaml' + '400': + $ref: '../../responses/400.yaml' + '401': + $ref: '../../responses/401.yaml' + '403': + $ref: '../../responses/403.yaml' + '429': + $ref: '../../responses/429.yaml' + '500': + $ref: '../../responses/500.yaml' +put: + operationId: putWorkflow + tags: + - Workflows + summary: Update Workflow + description: >- + Perform a full update of a workflow. The updated workflow object is returned in the response. + security: + - userAuth: [sp:workflow:manage] + parameters: + - name: id + in: path + description: Id of the Workflow + required: true + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + requestBody: + required: true + content: + application/json: + schema: + $ref: '../../schemas/workflows/WorkflowBody.yaml' + responses: + '200': + description: The Workflow object + content: + application/json: + schema: + $ref: '../../schemas/workflows/Workflow.yaml' + '400': + $ref: '../../responses/400.yaml' + '401': + $ref: '../../responses/401.yaml' + '403': + $ref: '../../responses/403.yaml' + '429': + $ref: '../../responses/429.yaml' + '500': + $ref: '../../responses/500.yaml' +patch: + operationId: patchWorkflow + tags: + - Workflows + summary: Patch Workflow + description: >- + Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + security: + - userAuth: [sp:workflow:manage] + parameters: + - name: id + in: path + description: Id of the Workflow + required: true + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + requestBody: + required: true + content: + application/json-patch+json: + schema: + type: array + items: + $ref: '../../schemas/JsonPatchOperation.yaml' + examples: + Update all patchable fields: + description: Demonstrate how to update each patchable field in one PATCH request. + value: + [ + { + "op": "replace", + "path": "/name", + "value": "Send Email" + }, + { + "op": "replace", + "path": "/owner", + "value": { + "type": "IDENTITY", + "id": "2c91808568c529c60168cca6f90c1313", + "name": "William Wilson" + + } + }, + { + "op": "replace", + "path": "/description", + "value": "Send an email to the identity who's attributes changed." + }, + { + "op": "replace", + "path": "/enabled", + "value": false + }, + { + "op": "replace", + "path": "/definition", + "value": { + "start": "Send Email Test", + "steps": { + "Send Email": { + "actionId": "sp:send-email", + "attributes": { + "body": "This is a test", + "from": "sailpoint@sailpoint.com", + "recipientId.$": "$.identity.id", + "subject": "test" + }, + "nextStep": "success", + "selectResult": null, + "type": "action" + }, + "success": { + "type": "success" + } + } + } + }, + { + "op": "replace", + "path": "/trigger", + "value": { + "type": "EVENT", + "attributes": { + "id": "idn:identity-attributes-changed" + } + } + } + ] + responses: + '200': + description: The Workflow object + content: + application/json: + schema: + $ref: '../../schemas/workflows/Workflow.yaml' + '400': + $ref: '../../responses/400.yaml' + '401': + $ref: '../../responses/401.yaml' + '403': + $ref: '../../responses/403.yaml' + '429': + $ref: '../../responses/429.yaml' + '500': + $ref: '../../responses/500.yaml' +delete: + operationId: deleteWorkflow + tags: + - Workflows + summary: Delete Workflow By Id + description: >- + Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. + security: + - userAuth: [sp:workflow:manage] + parameters: + - name: id + in: path + description: Id of the Workflow + required: true + style: simple + explode: false + schema: + type: string + example: c17bea3a-574d-453c-9e04-4365fbf5af0b + responses: + '204': + $ref: '../../responses/204.yaml' + '400': + $ref: '../../responses/400.yaml' + '401': + $ref: '../../responses/401.yaml' + '403': + $ref: '../../responses/403.yaml' + '429': + $ref: '../../responses/429.yaml' + '500': + $ref: '../../responses/500.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/workflows/workflows.yaml b/static/api-specs/idn/v2025/paths/workflows/workflows.yaml new file mode 100644 index 000000000..0a853cec0 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/workflows/workflows.yaml @@ -0,0 +1,154 @@ +get: + operationId: listWorkflows + tags: + - Workflows + summary: List Workflows + description: >- + List all workflows in the tenant. + security: + - userAuth: [sp:workflow:read] + responses: + '200': + description: >- + List of workflows + content: + application/json: + schema: + type: array + items: + $ref: '../../schemas/workflows/Workflow.yaml' + '400': + $ref: '../../responses/400.yaml' + '401': + $ref: '../../responses/401.yaml' + '403': + $ref: '../../responses/403.yaml' + '429': + $ref: '../../responses/429.yaml' + '500': + $ref: '../../responses/500.yaml' +post: + operationId: createWorkflow + tags: + - Workflows + summary: Create Workflow + description: >- + Create a new workflow with the desired trigger and steps specified in the request body. + security: + - userAuth: [sp:workflow:manage] + requestBody: + required: true + content: + application/json: + schema: + allOf: + - required: + - name + - $ref: '../../schemas/workflows/WorkflowBody.yaml' + examples: + Event Trigger: + description: Workflow initiated by an event trigger + value: + name: Send Email + owner: + type: IDENTITY + id: 2c91808568c529c60168cca6f90c1313 + name: William Wilson + description: Send an email to the identity who's attributes changed. + definition: + start: Send Email Test + steps: + Send Email: + actionId: sp:send-email + attributes: + body: This is a test + from: sailpoint@sailpoint.com + recipientId.$: "$.identity.id" + subject: test + nextStep: success + selectResult: + type: action + success: + type: success + enabled: false + trigger: + type: EVENT + attributes: + id: idn:identity-attributes-changed + filter: "$.changes[?(@.attribute == 'manager')]" + Scheduled Trigger: + description: Workflow initiated by a scheduled trigger + value: + name: Send Email + owner: + type: IDENTITY + id: 2c91808568c529c60168cca6f90c1313 + name: William Wilson + description: Send an email to the identity who's attributes changed. + definition: + start: Send Email Test + steps: + Send Email: + actionId: sp:send-email + attributes: + body: This is a test + from: sailpoint@sailpoint.com + recipientId.$: "$.identity.id" + subject: test + nextStep: success + selectResult: + type: action + success: + type: success + enabled: false + trigger: + type: SCHEDULED + attributes: + cronString: 0 * */3 */5 * + External Trigger: + description: Workflow initiated by an external trigger + value: + name: Send Email + owner: + type: IDENTITY + id: 2c91808568c529c60168cca6f90c1313 + name: William Wilson + description: Send an email to the identity whose attributes changed. + definition: + start: Send Email Test + steps: + Send Email: + actionId: sp:send-email + attributes: + body: This is a test + from: sailpoint@sailpoint.com + recipientId.$: "$.identity.id" + subject: test + nextStep: success + selectResult: + type: action + success: + type: success + enabled: false + trigger: + type: EXTERNAL + attributes: + name: search-and-notify + description: Run a search and notify the results + responses: + '200': + description: The Workflow object + content: + application/json: + schema: + $ref: '../../schemas/workflows/Workflow.yaml' + '400': + $ref: '../../responses/400.yaml' + '401': + $ref: '../../responses/401.yaml' + '403': + $ref: '../../responses/403.yaml' + '429': + $ref: '../../responses/429.yaml' + '500': + $ref: '../../responses/500.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/workgroups/bulk-add-workgroup-members.yaml b/static/api-specs/idn/v2025/paths/workgroups/bulk-add-workgroup-members.yaml new file mode 100644 index 000000000..d4dafef60 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/workgroups/bulk-add-workgroup-members.yaml @@ -0,0 +1,57 @@ +post: + operationId: updateWorkgroupMembers + security: + - userAuth: + - idn:workgroup:write + tags: + - Governance Groups + summary: Add members to Governance Group + description: 'This API adds one or more members to a Governance Group. A token + with API, ORG_ADMIN authority is required to call this API. + + + > **Following field of Identity is an optional field in the request.** + + + > **name**' + parameters: + - name: workgroupId + in: path + description: ID of the Governance Group. + required: true + schema: + type: string + example: 2c91808a7813090a017814121919ecca + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + requestBody: + description: List of identities to be added to a Governance Group members list. + required: true + content: + application/json: + schema: + $ref: ../../schemas/workgroups/BulkWorkgroupMembersRequest.yaml + responses: + '207': + description: List of added and not added identities into Governance Group members + list. + content: + application/json: + schema: + $ref: ../../schemas/workgroups/WorkgroupMemberBulkAddResponse.yaml + '400': + $ref: ../../responses/400.yaml + '401': + $ref: ../../responses/401.yaml + '403': + $ref: ../../responses/403.yaml + '429': + $ref: ../../responses/429.yaml + '500': + $ref: ../../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/workgroups/bulk-delete-workgroup-members.yaml b/static/api-specs/idn/v2025/paths/workgroups/bulk-delete-workgroup-members.yaml new file mode 100644 index 000000000..65e6ff356 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/workgroups/bulk-delete-workgroup-members.yaml @@ -0,0 +1,60 @@ +post: + operationId: deleteWorkgroupMembers + security: + - userAuth: + - idn:workgroup:write + - applicationAuth: + - idn:workgroup:write + x-sailpoint-userLevels: + - ORG_ADMIN + tags: + - Governance Groups + summary: Remove members from Governance Group + description: 'This API removes one or more members from a Governance Group. A + + > **Following field of Identity is an optional field in the request.** + + + > **name**' + parameters: + - name: workgroupId + in: path + description: ID of the Governance Group. + required: true + schema: + type: string + example: 2c91808a7813090a017814121919ecca + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + requestBody: + description: List of identities to be removed from a Governance Group members + list. + required: true + content: + application/json: + schema: + $ref: ../../schemas/workgroups/BulkWorkgroupMembersRequest.yaml + responses: + '207': + description: List of deleted and not deleted identities from Governance Group + members list. + content: + application/json: + schema: + $ref: ../../schemas/workgroups/WorkgroupMemberBulkDeleteResponse.yaml + '400': + $ref: ../../responses/400.yaml + '401': + $ref: ../../responses/401.yaml + '403': + $ref: ../../responses/403.yaml + '429': + $ref: ../../responses/429.yaml + '500': + $ref: ../../responses/500.yaml diff --git a/static/api-specs/idn/v2025/paths/workgroups/connections.yaml b/static/api-specs/idn/v2025/paths/workgroups/connections.yaml new file mode 100644 index 000000000..d95fe5a6e --- /dev/null +++ b/static/api-specs/idn/v2025/paths/workgroups/connections.yaml @@ -0,0 +1,59 @@ +get: + operationId: listConnections + tags: + - Governance Groups + summary: List connections for Governance Group + description: This API returns list of connections associated with a Governance Group. + parameters: + - name: workgroupId + in: path + description: ID of the Governance Group. + required: true + schema: + type: string + example: 2c91808a7813090a017814121919ecca + - $ref: ../../parameters/offset.yaml + - $ref: ../../parameters/limit50.yaml + - $ref: ../../parameters/count.yaml + - in: query + name: sorters + schema: + type: string + format: comma-separated + description: 'Sort results using the standard syntax described in [V3 API Standard + Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **name, created, modified**' + example: name,-modified + required: false + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: List all connections associated with a Governance Group. + content: + application/json: + schema: + type: array + items: + $ref: ../../schemas/workgroups/WorkgroupConnectionDto.yaml + '400': + $ref: ../../responses/400.yaml + '401': + $ref: ../../responses/401.yaml + '403': + $ref: ../../responses/403.yaml + '429': + $ref: ../../responses/429.yaml + '500': + $ref: ../../responses/500.yaml + security: + - userAuth: + - idn:workgroup:read diff --git a/static/api-specs/idn/v2025/paths/workgroups/workgroup-members.yaml b/static/api-specs/idn/v2025/paths/workgroups/workgroup-members.yaml new file mode 100644 index 000000000..605c620f3 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/workgroups/workgroup-members.yaml @@ -0,0 +1,79 @@ +get: + operationId: listWorkgroupMembers + tags: + - Governance Groups + summary: List Governance Group Members + description: This API returns list of members associated with a Governance Group. + parameters: + - name: workgroupId + in: path + description: ID of the Governance Group. + required: true + schema: + type: string + example: 2c91808a7813090a017814121919ecca + - $ref: ../../parameters/offset.yaml + - $ref: ../../parameters/limit50.yaml + - $ref: ../../parameters/count.yaml + - in: query + name: sorters + schema: + type: string + format: comma-separated + description: 'Sort results using the standard syntax described in [V3 API Standard + Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **name, created, modified**' + example: name,-modified + required: false + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: List all members associated with a Governance Group. + content: + application/json: + schema: + type: array + items: + type: object + description: Identity of workgroup member. + properties: + type: + type: string + description: Workgroup member identity DTO type. + enum: + - IDENTITY + example: IDENTITY + id: + type: string + description: Workgroup member identity ID. + example: 2c7180a46faadee4016fb4e018c20642 + name: + type: string + description: Workgroup member identity display name. + example: Michael Michaels + email: + type: string + description: Workgroup member identity email. + example: michael.michaels@sailpoint.com + '400': + $ref: ../../responses/400.yaml + '401': + $ref: ../../responses/401.yaml + '403': + $ref: ../../responses/403.yaml + '429': + $ref: ../../responses/429.yaml + '500': + $ref: ../../responses/500.yaml + security: + - userAuth: + - idn:workgroup:read diff --git a/static/api-specs/idn/v2025/paths/workgroups/workgroup.yaml b/static/api-specs/idn/v2025/paths/workgroups/workgroup.yaml new file mode 100644 index 000000000..2b2f9ad54 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/workgroups/workgroup.yaml @@ -0,0 +1,156 @@ +get: + operationId: getWorkgroup + tags: + - Governance Groups + summary: Get Governance Group by Id + description: This API returns a Governance Groups by its ID. + parameters: + - in: path + name: id + required: true + schema: + type: string + description: ID of the Governance Group + example: 2c9180837ca6693d017ca8d097500149 + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: A Governance Group + content: + application/json: + schema: + $ref: ../../schemas/workgroups/WorkgroupDto.yaml + '400': + $ref: ../../responses/400.yaml + '401': + $ref: ../../responses/401.yaml + '403': + $ref: ../../responses/403.yaml + '429': + $ref: ../../responses/429.yaml + '500': + $ref: ../../responses/500.yaml + security: + - userAuth: + - idn:workgroup:read + - applicationAuth: + - idn:workgroup:read + x-sailpoint-userLevels: + - ORG_ADMIN +delete: + operationId: deleteWorkgroup + tags: + - Governance Groups + summary: Delete a Governance Group + description: This API deletes a Governance Group by its ID. + parameters: + - in: path + name: id + required: true + schema: + type: string + description: ID of the Governance Group + example: 2c9180837ca6693d017ca8d097500149 + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '204': + $ref: ../../responses/204.yaml + '400': + $ref: ../../responses/400.yaml + '401': + $ref: ../../responses/401.yaml + '403': + $ref: ../../responses/403.yaml + '429': + $ref: ../../responses/429.yaml + '500': + $ref: ../../responses/500.yaml + security: + - userAuth: + - idn:workgroup:write + - applicationAuth: + - idn:workgroup:write + x-sailpoint-userLevels: + - ORG_ADMIN +patch: + operationId: patchWorkgroup + tags: + - Governance Groups + summary: Patch a Governance Group + description: >- + This API updates an existing governance group by ID. The following + fields and objects are patchable: + + * name + + * description + + * owner + parameters: + - in: path + name: id + required: true + schema: + type: string + description: ID of the Governance Group + example: 2c9180837ca6693d017ca8d097500149 + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: ../../schemas/JsonPatchOperation.yaml + examples: + Replace Description: + description: Replace description of a Governance Group. + value: + - op: replace + path: /description + value: Governance Group new description. + responses: + '200': + description: A Governance Group. + content: + application/json: + schema: + $ref: ../../schemas/workgroups/WorkgroupDto.yaml + '400': + $ref: ../../responses/400.yaml + '401': + $ref: ../../responses/401.yaml + '403': + $ref: ../../responses/403.yaml + '429': + $ref: ../../responses/429.yaml + '500': + $ref: ../../responses/500.yaml + security: + - userAuth: + - idn:workgroup:write + - applicationAuth: + - idn:workgroup:write + x-sailpoint-userLevels: + - ORG_ADMIN diff --git a/static/api-specs/idn/v2025/paths/workgroups/workgroups-bulk-delete.yaml b/static/api-specs/idn/v2025/paths/workgroups/workgroups-bulk-delete.yaml new file mode 100644 index 000000000..c3c6553d3 --- /dev/null +++ b/static/api-specs/idn/v2025/paths/workgroups/workgroups-bulk-delete.yaml @@ -0,0 +1,60 @@ +post: + operationId: deleteWorkgroupsInBulk + summary: Delete Governance Group(s) + tags: + - Governance Groups + description: "\nThis API initiates a bulk deletion of one or more Governance Groups.\n\ + \n> If any of the indicated Governance Groups have one or more connections associated\ + \ with it,then those Governance Groups will be added in **inUse** list of the\ + \ response. Governance Group(s) marked as **inUse** can not be deleted.\n\n> \ + \ If any of the indicated Governance Groups is not does not exists in Organization,then\ + \ those Governance Groups will be added in **notFound** list of the response.\ + \ Governance Groups marked as **notFound** will not be deleted.\n\n> If any of\ + \ the indicated Governance Groups does not have any connections associated with\ + \ it,then those Governance Groups will be added in **deleted** list of the response.\ + \ A Governance Group marked as **deleted** will be deleted from current Organization.\n\ + \n> If the request contains any **inUse** or **notFound** Governance Group IDs\ + \ then it skips only these Governance Groups for deletion and deletes the rest\ + \ of Governance Groups which have no connections associated with it. \n\n> **This\ + \ API has limit number of Governance Groups can be deleted at one time. If the\ + \ request contains more then 100 Governance Groups IDs to be deleted then the\ + \ API will throw an exception.**" + requestBody: + required: true + content: + application/json: + schema: + $ref: ../../schemas/workgroups/WorkgroupBulkDeleteRequest.yaml + example: + ids: + - 567a697e-885b-495a-afc5-d55e1c23a302 + - c7b0f7b2-1e78-4063-b294-a555333dacd2 + responses: + '207': + description: Governance Group bulk delete response. + content: + application/json: + schema: + $ref: ../../schemas/workgroups/WorkgroupBulkDeleteResponse.yaml + '400': + $ref: ../../responses/400.yaml + '401': + $ref: ../../responses/401.yaml + '403': + $ref: ../../responses/403.yaml + '429': + $ref: ../../responses/429.yaml + '500': + $ref: ../../responses/500.yaml + security: + - userAuth: + - idn:workgroup:write + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true diff --git a/static/api-specs/idn/v2025/paths/workgroups/workgroups.yaml b/static/api-specs/idn/v2025/paths/workgroups/workgroups.yaml new file mode 100644 index 000000000..d3428826a --- /dev/null +++ b/static/api-specs/idn/v2025/paths/workgroups/workgroups.yaml @@ -0,0 +1,114 @@ +get: + operationId: listWorkgroups + tags: + - Governance Groups + summary: List Governance Groups + description: This API returns list of Governance Groups + parameters: + - $ref: ../../parameters/offset.yaml + - $ref: ../../parameters/limit50.yaml + - $ref: ../../parameters/count.yaml + - in: query + name: filters + schema: + type: string + description: 'Filter results using the standard syntax described in [V3 API Standard + Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) + + + Filtering is supported for the following fields and operators: + + + **id**: *eq, in, sw* + + + **name**: *eq, sw, in* + + + **memberships.identityId**: *eq, in*' + example: name sw "Test" + required: false + - in: query + name: sorters + schema: + type: string + format: comma-separated + description: 'Sort results using the standard syntax described in [V3 API Standard + Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) + + + Sorting is supported for the following fields: **name, created, modified, id, + description**' + example: name,-modified + required: false + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + responses: + '200': + description: List of Governance Groups + content: + application/json: + schema: + type: array + items: + $ref: ../../schemas/workgroups/WorkgroupDto.yaml + '400': + $ref: ../../responses/400.yaml + '401': + $ref: ../../responses/401.yaml + '403': + $ref: ../../responses/403.yaml + '429': + $ref: ../../responses/429.yaml + '500': + $ref: ../../responses/500.yaml + security: + - userAuth: + - idn:workgroup:read +post: + operationId: createWorkgroup + security: + - userAuth: + - idn:workgroup:write + tags: + - Governance Groups + summary: Create a new Governance Group. + description: This API creates a new Governance Group. + requestBody: + required: true + content: + application/json: + schema: + $ref: ../../schemas/workgroups/WorkgroupDto.yaml + responses: + '200': + description: Governance Group object created. + content: + application/json: + schema: + $ref: ../../schemas/workgroups/WorkgroupDto.yaml + '400': + $ref: ../../responses/400.yaml + '401': + $ref: ../../responses/401.yaml + '403': + $ref: ../../responses/403.yaml + '429': + $ref: ../../responses/429.yaml + '500': + $ref: ../../responses/500.yaml + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true diff --git a/static/api-specs/idn/v2025/responses/202.yaml b/static/api-specs/idn/v2025/responses/202.yaml new file mode 100644 index 000000000..0a6066ac7 --- /dev/null +++ b/static/api-specs/idn/v2025/responses/202.yaml @@ -0,0 +1,5 @@ +description: Accepted - Returned if the request was successfully accepted into the system. +content: + application/json: + schema: + type : object \ No newline at end of file diff --git a/static/api-specs/idn/v2025/responses/204.yaml b/static/api-specs/idn/v2025/responses/204.yaml new file mode 100644 index 000000000..e53b3bf50 --- /dev/null +++ b/static/api-specs/idn/v2025/responses/204.yaml @@ -0,0 +1 @@ +description: No content - indicates the request was successful but there is no content to be returned in the response. diff --git a/static/api-specs/idn/v2025/responses/400.yaml b/static/api-specs/idn/v2025/responses/400.yaml new file mode 100644 index 000000000..b7d82fa44 --- /dev/null +++ b/static/api-specs/idn/v2025/responses/400.yaml @@ -0,0 +1,5 @@ +description: Client Error - Returned if the request body is invalid. +content: + application/json: + schema: + $ref: '../schemas/ErrorResponseDto.yaml' diff --git a/static/api-specs/idn/v2025/responses/401.yaml b/static/api-specs/idn/v2025/responses/401.yaml new file mode 100644 index 000000000..5bd63b23c --- /dev/null +++ b/static/api-specs/idn/v2025/responses/401.yaml @@ -0,0 +1,10 @@ +description: Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. +content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: "JWT validation failed: JWT is expired" + diff --git a/static/api-specs/idn/v2025/responses/403.yaml b/static/api-specs/idn/v2025/responses/403.yaml new file mode 100644 index 000000000..36961e838 --- /dev/null +++ b/static/api-specs/idn/v2025/responses/403.yaml @@ -0,0 +1,15 @@ +description: Forbidden - Returned if the user you are running as, doesn't have access to this end-point. +content: + application/json: + schema: + $ref: '../schemas/ErrorResponseDto.yaml' + examples: + "403": + summary: An example of a 403 response object + value: + detailCode: "403 Forbidden" + trackingId: "b21b1f7ce4da4d639f2c62a57171b427" + messages: + - locale: "en-US" + localeOrigin: "DEFAULT" + text: "The server understood the request but refuses to authorize it." diff --git a/static/api-specs/idn/v2025/responses/404.yaml b/static/api-specs/idn/v2025/responses/404.yaml new file mode 100644 index 000000000..7d4f597c9 --- /dev/null +++ b/static/api-specs/idn/v2025/responses/404.yaml @@ -0,0 +1,16 @@ +description: Not Found - returned if the request URL refers to a resource or object that does not exist +content: + application/json: + schema: + $ref: '../schemas/ErrorResponseDto.yaml' + examples: + "404": + summary: An example of a 404 response object + value: + detailCode: "404 Not found" + trackingId: "b21b1f7ce4da4d639f2c62a57171b427" + messages: + - locale: "en-US" + localeOrigin: "DEFAULT" + text: "The server did not find a current representation for the target resource." + \ No newline at end of file diff --git a/static/api-specs/idn/v2025/responses/405.yaml b/static/api-specs/idn/v2025/responses/405.yaml new file mode 100644 index 000000000..222bee3ca --- /dev/null +++ b/static/api-specs/idn/v2025/responses/405.yaml @@ -0,0 +1,16 @@ +description: Method Not Allowed - indicates that the server knows the request method, but the target resource doesn't support this method. +content: + application/json: + schema: + type: object + properties: + errorName: + description: A message describing the error + example: "NotSupportedException" + errorMessage: + description: Description of the error + example: Cannot consume content type + trackingId: + type: string + description: Unique tracking id for the error. + example: e7eab60924f64aa284175b9fa3309599 diff --git a/static/api-specs/idn/v2025/responses/412.yaml b/static/api-specs/idn/v2025/responses/412.yaml new file mode 100644 index 000000000..e45f4354e --- /dev/null +++ b/static/api-specs/idn/v2025/responses/412.yaml @@ -0,0 +1,9 @@ +description: Precondition Failed - Returned in response if API/Feature not enabled for an organization. +content: + application/json: + schema: + type: object + properties: + message: + description: A message describing the error + example: " API/Feature not enabled for your organization." diff --git a/static/api-specs/idn/v2025/responses/429.yaml b/static/api-specs/idn/v2025/responses/429.yaml new file mode 100644 index 000000000..6b2480dba --- /dev/null +++ b/static/api-specs/idn/v2025/responses/429.yaml @@ -0,0 +1,9 @@ +description: 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. +content: + application/json: + schema: + type: object + properties: + message: + description: A message describing the error + example: " Rate Limit Exceeded " diff --git a/static/api-specs/idn/v2025/responses/500.yaml b/static/api-specs/idn/v2025/responses/500.yaml new file mode 100644 index 000000000..9b92e87f6 --- /dev/null +++ b/static/api-specs/idn/v2025/responses/500.yaml @@ -0,0 +1,15 @@ +description: Internal Server Error - Returned if there is an unexpected error. +content: + application/json: + schema: + $ref: '../schemas/ErrorResponseDto.yaml' + examples: + "500": + summary: An example of a 500 response object + value: + detailCode: "500.0 Internal Fault" + trackingId: "b21b1f7ce4da4d639f2c62a57171b427" + messages: + - locale: "en-US" + localeOrigin: "DEFAULT" + text: "An internal fault occurred." \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/AWSCredentialsResponse.yaml b/static/api-specs/idn/v2025/schemas/AWSCredentialsResponse.yaml new file mode 100644 index 000000000..4bdf0593e --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AWSCredentialsResponse.yaml @@ -0,0 +1,48 @@ +description: AWS Credentials Response +type: object +properties: + org: + description: Org name + readOnly: true + type: string + example: example-megapod + s3ProxyEnabled: + description: Enabled s3 proxy for VA's + readOnly: true + type: boolean + example: true + cookbook: + description: VA cookbook + readOnly: true + type: string + example: va-cookbook-info + awsId: + description: VA cookbook + readOnly: true + type: string + example: 1234 + awsSessionToken: + description: Session token + readOnly: true + type: string + example: FwoGZXIvYXdzEC8aDDjLKabbNpuXhf3zdyKUBN + awsAccessKeyId: + description: Access Key Id + readOnly: true + type: string + example: ASIAV5E54XOG2ZY3FQM4 + awsSecretAccessKey: + description: Secret Access Key + readOnly: true + type: string + example: fvTiyWJQWMW49EqSIQHuFNTHMnoWpSuPHrYn2PtT + awsExpiration: + description: An expiration date + readOnly: true + type: string + example: 2021-11-20T01:48:54.000Z + awsBucketName: + description: Bucket Name + readOnly: true + type: string + example: va-images diff --git a/static/api-specs/idn/v2025/schemas/AccessConstraint.yaml b/static/api-specs/idn/v2025/schemas/AccessConstraint.yaml new file mode 100644 index 000000000..2260315a2 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessConstraint.yaml @@ -0,0 +1,26 @@ +type : object +properties: + type: + type: string + enum: + - ENTITLEMENT + - ACCESS_PROFILE + - ROLE + description: Type of Access + example: ENTITLEMENT + ids: + description: Must be set only if operator is SELECTED. + type: array + items: + type: string + example: [2c90ad2a70ace7d50170acf22ca90010] + operator: + type: string + enum: + - ALL + - SELECTED + description: Used to determine whether the scope of the campaign should be reduced for selected ids or all. + example: SELECTED +required: + - type + - operator diff --git a/static/api-specs/idn/v2025/schemas/AccessCriteria.yaml b/static/api-specs/idn/v2025/schemas/AccessCriteria.yaml new file mode 100644 index 000000000..ca03510f0 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessCriteria.yaml @@ -0,0 +1,40 @@ +type: object +properties: + name: + type: string + description: Business name for the access construct list + example: "money-in" + criteriaList: + type: array + description: List of criteria. There is a min of 1 and max of 50 items in the list. + minItems: 1 + maxItems: 50 + items: + type: object + properties: + type: + type: string + enum: + - ENTITLEMENT + description: Type of the propery to which this reference applies to + example: ENTITLEMENT + id: + type: string + description: ID of the object to which this reference applies to + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Human-readable display name of the object to which this reference applies to + example: Administrator + example: [ + { + type: "ENTITLEMENT", + id: "2c9180866166b5b0016167c32ef31a66", + name: "Administrator" + }, + { + type: "ENTITLEMENT", + id: "2c9180866166b5b0016167c32ef31a67", + name: "Administrator" + } + ] diff --git a/static/api-specs/idn/v2025/schemas/AccessGranterAuthSupportLoginResponse.yaml b/static/api-specs/idn/v2025/schemas/AccessGranterAuthSupportLoginResponse.yaml new file mode 100644 index 000000000..bd7b1c395 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessGranterAuthSupportLoginResponse.yaml @@ -0,0 +1,33 @@ +type: object +properties: + accessGranterTenant: + type: string + description: The tenant that is granting access and in need of support. + example: acme-solar + authUserName: + type: string + description: The username in the target tenant that the authTenant's support and services user will log in as. + example: slpt.services + role: + type: string + description: The user access role in the auth tenant capable of providing admin-level support + example: Support and Services Role + supportLoginUrl: + type: string + description: The url used to start the support login flow to granter tenant. + example: https://sailpoint.login.sailpoint.com/auth/support/login?tenant=acme-solar + expirationDate: + type: string + format: date-time + description: When the auth support login access expires. + example: "2019-08-23T18:52:59.162Z" + modified: + type: string + format: date-time + description: When the request was last modified. + example: "2019-08-23T18:52:59.162Z" + created: + type: string + format: date-time + description: When the request was created. + example: "2019-08-23T18:40:35.772Z" diff --git a/static/api-specs/idn/v2025/schemas/AccessItemAccessProfileResponse.yaml b/static/api-specs/idn/v2025/schemas/AccessItemAccessProfileResponse.yaml new file mode 100644 index 000000000..ddbcfb5a0 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessItemAccessProfileResponse.yaml @@ -0,0 +1,53 @@ +type: object +properties: + accessType: + type: string + example: accessProfile + description: the access item type. accessProfile in this case + id: + type: string + example: 2c918087763e69d901763e72e97f006f + description: the access item id + name: + type: string + example: sample + description: the access profile name + sourceName: + type: string + example: DataScienceDataset + description: the name of the source + sourceId: + type: string + example: 2793o32dwd + description: the id of the source + description: + type: string + example: AccessProfile - Workday/Citizenship access + description: the description for the access profile + displayName: + type: string + example: Dr. Arden Rogahn MD + description: the display name of the identity + entitlementCount: + type: string + example: 12 + description: the number of entitlements the access profile will create + appDisplayName: + type: string + example: AppName + description: the name of + removeDate: + type: string + example: 2024-07-01T06:00:00.00Z + description: the date the access profile is no longer assigned to the specified identity + standalone: + type: boolean + example: false + description: indicates whether the access profile is standalone + revocable: + type: boolean + example: true + description: indicates whether the access profile is +required: + - standalone + - revocable \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/AccessItemAccountResponse.yaml b/static/api-specs/idn/v2025/schemas/AccessItemAccountResponse.yaml new file mode 100644 index 000000000..20bc0914a --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessItemAccountResponse.yaml @@ -0,0 +1,31 @@ +type: object +properties: + accessType: + type: string + example: account + description: the access item type. account in this case + id: + type: string + example: 2c918087763e69d901763e72e97f006f + description: the access item id + nativeIdentity: + type: string + example: dr.arden.ogahn.d + description: the native identifier used to uniquely identify an acccount + sourceName: + type: string + example: DataScienceDataset + description: the name of the source + sourceId: + type: string + example: 2793o32dwd + description: the id of the source + entitlementCount: + type: string + example: 12 + description: the number of entitlements the account will create + displayName: + type: string + example: Dr. Arden Rogahn MD + description: the display name of the identity + \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/AccessItemAppResponse.yaml b/static/api-specs/idn/v2025/schemas/AccessItemAppResponse.yaml new file mode 100644 index 000000000..6fda71816 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessItemAppResponse.yaml @@ -0,0 +1,24 @@ +type: object +properties: + accessType: + type: string + example: app + description: the access item type. entitlement in this case + id: + type: string + example: 2c918087763e69d901763e72e97f006f + description: the access item id + displayName: + type: string + example: Display Name + description: the access item display name + sourceName: + type: string + example: appName + description: the associated source name if it exists + appRoleId: + type: string + example: 2c918087763e69d901763e72e97f006f + description: the app role id + + \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/AccessItemAssociated.yaml b/static/api-specs/idn/v2025/schemas/AccessItemAssociated.yaml new file mode 100644 index 000000000..2cba7515e --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessItemAssociated.yaml @@ -0,0 +1,45 @@ +type: object +properties: + accessItem: + type: object + oneOf: + - $ref: './AccessItemAccessProfileResponse.yaml' + - $ref: './AccessItemAccountResponse.yaml' + - $ref: './AccessItemAppResponse.yaml' + - $ref: './AccessItemEntitlementResponse.yaml' + - $ref: './AccessItemRoleResponse.yaml' + example: + id: 8c190e6787aa4ed9a90bd9d5344523fb + accessType: account + nativeIdentity: 127999 + sourceName: JDBC Entitlements Source + entitlementCount: 0 + displayName: Sample Name + identityId: + type: string + description: the identity id + example: 8c190e6787aa4ed9a90bd9d5344523fb + eventType: + type: string + description: the event type + example: AccessItemAssociated + dt: + type: string + description: the date of event + example: '2019-03-08T22:37:33.901Z' + governanceEvent: + $ref: './CorrelatedGovernanceEvent.yaml' + example: + name: Manager Certification for Jon Snow + dt: '2019-03-08T22:37:33.901Z' + type: certification + governanceId: 2c91808a77ff216301782327a50f09bf + owners: + - id: bc693f07e7b645539626c25954c58554 + displayName: Jon Snow + reviewers: + - id: bc693f07e7b645539626c25954c58554 + displayName: Jon Snow + decisionMaker: + id: bc693f07e7b645539626c25954c58554 + displayName: Jon Snow \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/AccessItemDiff.yaml b/static/api-specs/idn/v2025/schemas/AccessItemDiff.yaml new file mode 100644 index 000000000..331d81e74 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessItemDiff.yaml @@ -0,0 +1,21 @@ +type: object +properties: + id: + type: string + description: the id of the access item + eventType: + type: string + enum: + - ADD + - REMOVE + displayName: + type: string + description: the display name of the access item + sourceName: + type: string + description: the source name of the access item +example: + id: 2c91808c7726345b017726a0a2fb013b + eventType: ADD + displayName: Test + sourceName: Source \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/AccessItemDiffSummary.yaml b/static/api-specs/idn/v2025/schemas/AccessItemDiffSummary.yaml new file mode 100644 index 000000000..3940ef31f --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessItemDiffSummary.yaml @@ -0,0 +1,11 @@ +type: object +properties: + accessItemAdded: + type: number + description: the count of access item added + accessItemAdded: + type: number + description: the count of access item removed +example: + accessAdded: 3 + accessRemoved: 2 \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/AccessItemEntitlementResponse.yaml b/static/api-specs/idn/v2025/schemas/AccessItemEntitlementResponse.yaml new file mode 100644 index 000000000..36d47a8c2 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessItemEntitlementResponse.yaml @@ -0,0 +1,54 @@ +type: object +properties: + accessType: + type: string + example: entitlement + description: the access item type. entitlement in this case + id: + type: string + example: 2c918087763e69d901763e72e97f006f + description: the access item id + attribute: + type: string + example: groups + description: the entitlement attribute + value: + type: string + example: Upward mobility access + description: the associated value + entitlementType: + type: string + example: entitlement + description: the type of entitlement + sourceName: + type: string + example: DataScienceDataset + description: the name of the source + sourceId: + type: string + example: 2793o32dwd + description: the id of the source + description: + type: string + example: Entitlement - Workday/Citizenship access + description: the description for the entitlment + displayName: + type: string + example: Dr. Arden Rogahn MD + description: the display name of the identity + standalone: + type: boolean + example: true + description: indicates whether the entitlement is standalone + privileged: + type: boolean + example: false + description: indicates whether the entitlement is privileged + cloudGoverned: + type: boolean + example: true + description: indicates whether the entitlement is cloud governed +required: + - standalone + - privileged + - cloudGoverned \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/AccessItemOwnerDto.yaml b/static/api-specs/idn/v2025/schemas/AccessItemOwnerDto.yaml new file mode 100644 index 000000000..8c03bab0b --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessItemOwnerDto.yaml @@ -0,0 +1,17 @@ +type: object +description: Access item owner's identity. +properties: + type: + type: string + description: Access item owner's DTO type. + enum: + - IDENTITY + example: IDENTITY + id: + type: string + description: Access item owner's identity ID. + example: 2c9180a46faadee4016fb4e018c20639 + name: + type: string + description: Access item owner's human-readable display name. + example: Support diff --git a/static/api-specs/idn/v2025/schemas/AccessItemRef.yaml b/static/api-specs/idn/v2025/schemas/AccessItemRef.yaml new file mode 100644 index 000000000..012d918ea --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessItemRef.yaml @@ -0,0 +1,14 @@ +type: object +properties: + id: + type: string + description: ID of the access item to retrieve the recommendation for. + example: '2c938083633d259901633d2623ec0375' + type: + type: string + example: ENTITLEMENT + description: Access item's type. + enum: + - ENTITLEMENT + - ACCESS_PROFILE + - ROLE \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/AccessItemRemoved.yaml b/static/api-specs/idn/v2025/schemas/AccessItemRemoved.yaml new file mode 100644 index 000000000..abc177e75 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessItemRemoved.yaml @@ -0,0 +1,46 @@ +type: object +properties: + accessItem: + type: object + oneOf: + - $ref: './AccessItemAccessProfileResponse.yaml' + - $ref: './AccessItemAccountResponse.yaml' + - $ref: './AccessItemAppResponse.yaml' + - $ref: './AccessItemEntitlementResponse.yaml' + - $ref: './AccessItemRoleResponse.yaml' + example: + id: 8c190e6787aa4ed9a90bd9d5344523fb + accessType: account + nativeIdentity: 127999 + sourceName: JDBC Entitlements Source + entitlementCount: 0 + displayName: Sample Name + identityId: + type: string + description: the identity id + example: 8c190e6787aa4ed9a90bd9d5344523fb + eventType: + type: string + description: the event type + example: AccessItemRemoved + dt: + type: string + description: the date of event + example: '2019-03-08T22:37:33.901Z' + governanceEvent: + $ref: './CorrelatedGovernanceEvent.yaml' + example: + name: Manager Certification for Jon Snow + dt: '2019-03-08T22:37:33.901Z' + type: certification + governanceId: 2c91808a77ff216301782327a50f09bf + owners: + - id: bc693f07e7b645539626c25954c58554 + displayName: Jon Snow + reviewers: + - id: bc693f07e7b645539626c25954c58554 + displayName: Jon Snow + decisionMaker: + id: bc693f07e7b645539626c25954c58554 + displayName: Jon Snow + diff --git a/static/api-specs/idn/v2025/schemas/AccessItemRequestedFor.yaml b/static/api-specs/idn/v2025/schemas/AccessItemRequestedFor.yaml new file mode 100644 index 000000000..45bcb3c0a --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessItemRequestedFor.yaml @@ -0,0 +1,17 @@ +type: object +description: Identity the access item is requested for. +properties: + type: + type: string + description: DTO type of identity the access item is requested for. + enum: + - IDENTITY + example: IDENTITY + id: + type: string + description: ID of identity the access item is requested for. + example: 2c4180a46faadee4016fb4e018c20626 + name: + type: string + description: Human-readable display name of identity the access item is requested for. + example: Robert Robinson diff --git a/static/api-specs/idn/v2025/schemas/AccessItemRequestedForDto.yaml b/static/api-specs/idn/v2025/schemas/AccessItemRequestedForDto.yaml new file mode 100644 index 000000000..45bcb3c0a --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessItemRequestedForDto.yaml @@ -0,0 +1,17 @@ +type: object +description: Identity the access item is requested for. +properties: + type: + type: string + description: DTO type of identity the access item is requested for. + enum: + - IDENTITY + example: IDENTITY + id: + type: string + description: ID of identity the access item is requested for. + example: 2c4180a46faadee4016fb4e018c20626 + name: + type: string + description: Human-readable display name of identity the access item is requested for. + example: Robert Robinson diff --git a/static/api-specs/idn/v2025/schemas/AccessItemRequester.yaml b/static/api-specs/idn/v2025/schemas/AccessItemRequester.yaml new file mode 100644 index 000000000..1f13b8bab --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessItemRequester.yaml @@ -0,0 +1,17 @@ +type: object +description: Access item requester's identity. +properties: + type: + type: string + description: Access item requester's DTO type. + enum: + - IDENTITY + example: IDENTITY + id: + type: string + description: Access item requester's identity ID. + example: 2c7180a46faadee4016fb4e018c20648 + name: + type: string + description: Access item owner's human-readable display name. + example: William Wilson diff --git a/static/api-specs/idn/v2025/schemas/AccessItemRequesterDto.yaml b/static/api-specs/idn/v2025/schemas/AccessItemRequesterDto.yaml new file mode 100644 index 000000000..1f13b8bab --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessItemRequesterDto.yaml @@ -0,0 +1,17 @@ +type: object +description: Access item requester's identity. +properties: + type: + type: string + description: Access item requester's DTO type. + enum: + - IDENTITY + example: IDENTITY + id: + type: string + description: Access item requester's identity ID. + example: 2c7180a46faadee4016fb4e018c20648 + name: + type: string + description: Access item owner's human-readable display name. + example: William Wilson diff --git a/static/api-specs/idn/v2025/schemas/AccessItemReviewedBy.yaml b/static/api-specs/idn/v2025/schemas/AccessItemReviewedBy.yaml new file mode 100644 index 000000000..e1f29f7e4 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessItemReviewedBy.yaml @@ -0,0 +1,17 @@ +type: object +description: Identity who reviewed the access item request. +properties: + type: + type: string + description: DTO type of identity who reviewed the access item request. + enum: + - IDENTITY + example: IDENTITY + id: + type: string + description: ID of identity who reviewed the access item request. + example: 2c3780a46faadee4016fb4e018c20652 + name: + type: string + description: Human-readable display name of identity who reviewed the access item request. + example: Allen Albertson diff --git a/static/api-specs/idn/v2025/schemas/AccessItemRoleResponse.yaml b/static/api-specs/idn/v2025/schemas/AccessItemRoleResponse.yaml new file mode 100644 index 000000000..d3685379b --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessItemRoleResponse.yaml @@ -0,0 +1,32 @@ +type: object +properties: + accessType: + type: string + example: role + description: the access item type. role in this case + id: + type: string + example: 2c918087763e69d901763e72e97f006f + description: the access item id + displayName: + type: string + example: sample + description: the role display name + description: + type: string + example: Role - Workday/Citizenship access + description: the description for the role + sourceName: + type: string + example: Source Name + description: the associated source name if it exists + removeDate: + type: string + example: 2024-07-01T06:00:00.00Z + description: the date the role is no longer assigned to the specified identity + revocable: + type: boolean + example: true + description: indicates whether the role is revocable +required: + - revocable \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/AccessModelMetadata.yaml b/static/api-specs/idn/v2025/schemas/AccessModelMetadata.yaml new file mode 100644 index 000000000..0daf91a0e --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessModelMetadata.yaml @@ -0,0 +1,53 @@ +type: object +description: Metadata that describes an access item +properties: + key: + type: string + description: Unique identifier for the metadata type + example: iscCsp + name: + type: string + description: Human readable name of the metadata type + example: CSP + multiselect: + type: boolean + default: false + example: true + description: Allows selecting multiple values + status: + type: string + description: The state of the metadata item + example: active + type: + type: string + description: The type of the metadata item + example: governance + objectTypes: + type: array + description: The types of objects + items: + type: string + example: general + description: + type: string + description: Describes the metadata item + example: Indicates the type of deployment environment of an access item. + values: + type: array + description: The value to assign to the metadata item + items: + type: object + description: An individual value to assign to the metadata item + properties: + value: + type: string + description: The value to assign to the metdata item + example: "development" + name: + type: string + description: Display name of the value + example: Development + status: + type: string + description: The status of the individual value + example: active \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/AccessRecommendation.yaml b/static/api-specs/idn/v2025/schemas/AccessRecommendation.yaml new file mode 100644 index 000000000..601658889 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessRecommendation.yaml @@ -0,0 +1,22 @@ +type: object +properties: + access: + $ref: './AccessReference.yaml' + ignored: + type: boolean + description: Whether or not the identity has already chosen to ignore this recommendation. + requested: + type: boolean + description: Whether or not the identity has already chosen to request this recommendation. + viewed: + type: boolean + description: Whether or not the identity reportedly viewed this recommendation. + messages: + type: array + items: + $ref: './AccessRecommendationMessage.yaml' + translationMessages: + type: array + items: + type: object + $ref: './TranslationMessage.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/AccessRecommendationMessage.yaml b/static/api-specs/idn/v2025/schemas/AccessRecommendationMessage.yaml new file mode 100644 index 000000000..2ed4c46b9 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessRecommendationMessage.yaml @@ -0,0 +1,6 @@ +type: object +properties: + interpretation: + type: string + description: Information about why the access item was recommended. + example: 95% of your peers have this access. \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/AccessReference.yaml b/static/api-specs/idn/v2025/schemas/AccessReference.yaml new file mode 100644 index 000000000..2142d9740 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessReference.yaml @@ -0,0 +1,26 @@ +type: object +properties: + id: + type: string + format: UUID + description: ID of access item being recommended. + example: 2d9180835d2e5168015d32f890ca1581 + name: + type: string + description: Display name of the access item. + example: Applied Research Access + description: + type: string + description: Description of the access item. + example: Access to research information, lab results, and schematics + type: + $ref: './RequestableObjectType.yaml' + owner: + $ref: './AccessItemOwnerDto.yaml' + requestCommentsRequired: + type: boolean + description: If comments are required while requesting the access item. + apps: + type: array + items: + $ref: './ApplicationReference.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/AccessRequest.yaml b/static/api-specs/idn/v2025/schemas/AccessRequest.yaml new file mode 100644 index 000000000..078f47ffd --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessRequest.yaml @@ -0,0 +1,31 @@ +type : object +properties: + requestedFor: + description: A list of Identity IDs for whom the Access is requested. If it's a Revoke request, there can only be one Identity ID. + type: array + items: + type: string + example: 2c918084660f45d6016617daa9210584 + requestType: + $ref: 'AccessRequestType.yaml' + requestedItems: + type: array + items: + $ref: 'AccessRequestItem.yaml' + minItems: 1 + maxItems: 25 + clientMetadata: + type: object + additionalProperties: + type: string + example: + requestedAppId: 2c91808f7892918f0178b78da4a305a1 + requestedAppName: test-app + example: + requestedAppId: 2c91808f7892918f0178b78da4a305a1 + requestedAppName: test-app + description: >- + Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on + associated APIs such as /account-activities. + +required : ["requestedFor", "requestedItems"] \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/AccessRequestAdminItemStatus.yaml b/static/api-specs/idn/v2025/schemas/AccessRequestAdminItemStatus.yaml new file mode 100644 index 000000000..7aba5c851 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessRequestAdminItemStatus.yaml @@ -0,0 +1,143 @@ +type: object +properties: + id: + type: string + description: ID of the access request. This is a new property as of 2025. Older access requests may not have an ID. + example: 2c9180926cbfbddd016cbfc7c3b10010 + nullable: true + name: + type: string + description: Human-readable display name of the item being requested. + example: "AccessProfile1" + nullable: true + type: + type: string + enum: + - ACCESS_PROFILE + - ROLE + - ENTITLEMENT + - null + description: Type of requested object. + example: ACCESS_PROFILE + nullable: true + cancelledRequestDetails: + allOf: + - $ref: './CancelledRequestDetails.yaml' + - nullable: true + errorMessages: + type: array + nullable: true + items: + $ref: './ErrorMessageDtoList.yaml' + description: List of localized error messages, if any, encountered during the approval/provisioning process. + state: + $ref: './RequestedItemStatusRequestState.yaml' + approvalDetails: + type: array + items: + $ref: './ApprovalStatusDto.yaml' + description: Approval details for each item. + manualWorkItemDetails: + type: array + nullable: true + items: + $ref: './ManualWorkItemDetails.yaml' + description: Manual work items created for provisioning the item. + accountActivityItemId: + type: string + description: Id of associated account activity item. + example: "2c9180926cbfbddd016cbfc7c3b10010" + requestType: + $ref: './AccessRequestType.yaml' + modified: + type: string + format: date-time + description: When the request was last modified. + example: "2019-08-23T18:52:59.162Z" + nullable: true + created: + type: string + format: date-time + description: When the request was created. + example: "2019-08-23T18:40:35.772Z" + requester: + $ref: './AccessItemRequester.yaml' + requestedFor: + type: object + description: Identity access was requested for. + properties: + type: + type: string + enum: + - IDENTITY + description: Type of the object to which this reference applies + example: IDENTITY + id: + type: string + description: ID of the object to which this reference applies + example: 2c9180835d191a86015d28455b4b232a + name: + type: string + description: Human-readable display name of the object to which this reference applies + example: William Wilson + requesterComment: + allOf: + - $ref: './CommentDto.yaml' + - nullable: true + description: The requester's comment. + sodViolationContext: + allOf: + - $ref: './SodViolationContextCheckCompleted.yaml' + - nullable: true + description: The details of the SOD violations for the associated approval. + provisioningDetails: + allOf: + - $ref: './ProvisioningDetails.yaml' + - nullable: true + preApprovalTriggerDetails: + allOf: + - $ref: './PreApprovalTriggerDetails.yaml' + - nullable: true + accessRequestPhases: + type: array + items: + $ref: './AccessRequestPhases.yaml' + description: A list of Phases that the Access Request has gone through in order, to help determine the status of the request. + nullable: true + description: + type: string + description: Description associated to the requested object. + example: "This is the Engineering role that engineers are granted." + nullable: true + removeDate: + type: string + format: date-time + nullable: true + description: When the role access is scheduled for removal. + example: "2019-10-23T00:00:00.000Z" + cancelable: + type: boolean + default: false + description: True if the request can be canceled. + example: true + reauthorizationRequired: + type: boolean + default: false + description: True if re-auth is required. + example: true + accessRequestId: + type: string + description: This is the account activity id. + example: "2b838de9-db9b-abcf-e646-d4f274ad4238" + clientMetadata: + nullable: true + type: object + additionalProperties: + type: string + description: >- + Arbitrary key-value pairs, if any were included in the corresponding access request + example: + { + "key1": "value1", + "key2": "value2" + } \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/AccessRequestApproversListResponse.yaml b/static/api-specs/idn/v2025/schemas/AccessRequestApproversListResponse.yaml new file mode 100644 index 000000000..e1b1e1ceb --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessRequestApproversListResponse.yaml @@ -0,0 +1,22 @@ +type: object +properties: + id: + type: string + description: Approver id. + example: id12345 + email: + type: string + description: Email of the approver. + example: jdoe@sailpoint.com + name: + type: string + description: Name of the approver. + example: John Doe + approvalId: + type: string + description: Id of the approval item. + example: ap12345 + type: + type: string + description: Type of the object returned. In this case, the value for this field will always Identity. + example: Identity diff --git a/static/api-specs/idn/v2025/schemas/AccessRequestConfig.yaml b/static/api-specs/idn/v2025/schemas/AccessRequestConfig.yaml new file mode 100644 index 000000000..bd8097417 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessRequestConfig.yaml @@ -0,0 +1,26 @@ +type : object +properties: + approvalsMustBeExternal: + type: boolean + description: If this is true, approvals must be processed by an external system. Also, if this is true, it blocks Request Center access requests and returns an error for any user who isn't an org admin. + default: false + example: true + autoApprovalEnabled: + type: boolean + description: If this is true and the requester and reviewer are the same, the request is automatically approved. + default: false + example: true + reauthorizationEnabled: + type: boolean + description: If this is true, reauthorization will be enforced for appropriately configured access items. Enablement of this feature is currently in a limited state. + default: false + example: true + requestOnBehalfOfConfig: + $ref: './RequestOnBehalfOfConfig.yaml' + description: Request On Behalf Of configuration. + approvalReminderAndEscalationConfig: + $ref: './ApprovalReminderAndEscalationConfig.yaml' + description: Approval reminder and escalation configuration. + entitlementRequestConfig: + $ref: './EntitlementRequestConfig.yaml' + description: Entitlement request configuration. \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/AccessRequestContext.yaml b/static/api-specs/idn/v2025/schemas/AccessRequestContext.yaml new file mode 100644 index 000000000..d3a7fe63f --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessRequestContext.yaml @@ -0,0 +1,6 @@ +type: object +properties: + contextAttributes: + type: array + items: + $ref: "./ContextAttributeDto.yaml" diff --git a/static/api-specs/idn/v2025/schemas/AccessRequestIdentityMetrics.yaml b/static/api-specs/idn/v2025/schemas/AccessRequestIdentityMetrics.yaml new file mode 100644 index 000000000..1eebadab6 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessRequestIdentityMetrics.yaml @@ -0,0 +1,52 @@ +type: object +properties: + identitiesWithAccess: + type: integer + format: int64 + nullable: true + description: + A count of the provided manager's direct reports that have already been granted the access item in question. + example: 8 + identitiesWithActivity: + type: integer + format: int64 + nullable: true + description: >- + A count of the provided manager's direct reports that have activity within the associated source. + example: 5 + totalIdentities: + type: integer + format: int64 + nullable: true + description: >- + Total number of identities who share a manager with the identity requesting access. + example: 10 + squadAvailable: + type: boolean + default: false + description: >- + True if the manager's ID can be found. + False if the manager's ID cannot be found. + example: true + validActivityObject: + type: boolean + default: false + description: >- + True if the requested access item is associated with a single Activity Data Insights connector source. + False if the requested access item type is a role. If it's a role, it matches to multiple sources, + so a single relevant source can't be determined for activity metrics. + example: true + activitySourceConfigured: + type: boolean + default: false + description: >- + True if the Activity Data Insights connector is configured for the source associated with the requested access item. + False if the matching Activity Data Insights connector is not configured. + example: true + requestedObjectActive: + type: boolean + default: false + description: >- + True if the requested access item exists and is available. + False if the requested access item is either missing or deleted. + example: true \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/AccessRequestItem.yaml b/static/api-specs/idn/v2025/schemas/AccessRequestItem.yaml new file mode 100644 index 000000000..7b24f89f2 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessRequestItem.yaml @@ -0,0 +1,42 @@ +type : object +properties: + type: + type: string + # Can't use $ref to RequestableObjectType here because it's non-optional on access requests + enum: [ACCESS_PROFILE, ROLE, ENTITLEMENT] + description: The type of the item being requested. + example: ACCESS_PROFILE + id: + type: string + description: ID of Role, Access Profile or Entitlement being requested. + example: 2c9180835d2e5168015d32f890ca1581 + comment: + type: string + description: | + Comment provided by requester. + * Comment is required when the request is of type Revoke Access. + example: Requesting access profile for John Doe + clientMetadata: + type: object + additionalProperties: + type: string + example: + requestedAppId: 2c91808f7892918f0178b78da4a305a1 + requestedAppName: test-app + example: + requestedAppName: test-app + requestedAppId: 2c91808f7892918f0178b78da4a305a1 + description: >- + Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on + associated APIs such as /account-activities and /access-request-status. + removeDate: + type: string + description: | + The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. + * Specify a date in the future. + * The current SLA for the deprovisioning is 24 hours. + * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. + format: 'date-time' + example: '2020-07-11T21:23:15.000Z' +required : ["id", "type"] + diff --git a/static/api-specs/idn/v2025/schemas/AccessRequestItemResponse.yaml b/static/api-specs/idn/v2025/schemas/AccessRequestItemResponse.yaml new file mode 100644 index 000000000..44464d2a6 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessRequestItemResponse.yaml @@ -0,0 +1,41 @@ +type: object +properties: + operation: + type: string + example: Add + description: the access request item operation + accessItemType: + type: string + example: role + description: the access item type + name: + type: string + example: Role-1 + description: the name of access request item + decision: + type: string + example: APPROVED + enum: + - APPROVED + - REJECTED + description: the final decision for the access request + description: + type: string + example: The role descrition + description: the description of access request item + sourceId: + type: string + example: 8a80828f643d484f01643e14202e206f + description: the source id + sourceName: + type: string + example: Source1 + description: the source Name + approvalInfos: + type: array + example: + - name: John Snow + id: 8a80828f643d484f01643e14202e2000 + status: Approved + items: + $ref: './ApprovalInfoResponse.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/AccessRequestPhases.yaml b/static/api-specs/idn/v2025/schemas/AccessRequestPhases.yaml new file mode 100644 index 000000000..c3121fe1b --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessRequestPhases.yaml @@ -0,0 +1,44 @@ +type: object +properties: + started: + type: string + description: The time that this phase started. + format: 'date-time' + example: '2020-07-11T00:00:00Z' + finished: + type: string + description: The time that this phase finished. + format: 'date-time' + example: '2020-07-12T00:00:00Z' + nullable: true + name: + type: string + description: The name of this phase. + example: APPROVAL_PHASE + state: + type: string + enum: + - PENDING + - EXECUTING + - COMPLETED + - CANCELLED + - NOT_EXECUTED + description: The state of this phase. + example: COMPLETED + result: + type: string + enum: + - SUCCESSFUL + - FAILED + - null + description: The state of this phase. + example: SUCCESSFUL + nullable: true + phaseReference: + type: string + description: >- + A reference to another object on the RequestedItemStatus that contains more details about the phase. + Note that for the Provisioning phase, this will be empty if there are no manual work items. + example: 'approvalDetails' + nullable: true +description: Provides additional details about this access request phase. \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationActionItemDto.yaml b/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationActionItemDto.yaml new file mode 100644 index 000000000..e0877fbe4 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationActionItemDto.yaml @@ -0,0 +1,12 @@ +type: object +properties: + identityId: + type: string + format: UUID + description: The identity ID taking the action. + example: 2c91808570313110017040b06f344ec9 + access: + $ref: './AccessRequestRecommendationItem.yaml' +required: + - identityId + - access diff --git a/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationActionItemResponseDto.yaml b/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationActionItemResponseDto.yaml new file mode 100644 index 000000000..61ce4d4fb --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationActionItemResponseDto.yaml @@ -0,0 +1,13 @@ +type: object +properties: + identityId: + type: string + format: UUID + description: The identity ID taking the action. + example: 2c91808570313110017040b06f344ec9 + access: + $ref: './AccessRequestRecommendationItem.yaml' + timestamp: + type: string + format: 'date-time' + example: '2017-07-11T18:45:37.098Z' diff --git a/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationConfigDto.yaml b/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationConfigDto.yaml new file mode 100644 index 000000000..d56815b04 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationConfigDto.yaml @@ -0,0 +1,30 @@ +type: object +properties: + scoreThreshold: + type: number + format: float + description: The value that internal calculations need to exceed for recommendations to be made. + example: 0.5 + startDateAttribute: + type: string + description: Use to map an attribute name for determining identities' start date. + example: startDate + restrictionAttribute: + type: string + description: Use to only give recommendations based on this attribute. + example: location + moverAttribute: + type: string + description: Use to map an attribute name for determining whether identities are movers. + example: isMover + joinerAttribute: + type: string + description: Use to map an attribute name for determining whether identities are joiners. + example: isJoiner + useRestrictionAttribute: + type: boolean + description: Use only the attribute named in restrictionAttribute to make recommendations. + example: true + default: false +required: + - scoreThreshold diff --git a/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationItem.yaml b/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationItem.yaml new file mode 100644 index 000000000..6b584094a --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationItem.yaml @@ -0,0 +1,9 @@ +type: object +properties: + id: + type: string + format: UUID + description: ID of access item being recommended. + example: 2c9180835d2e5168015d32f890ca1581 + type: + $ref: './AccessRequestRecommendationItemType.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationItemDetail.yaml b/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationItemDetail.yaml new file mode 100644 index 000000000..3eba8e17b --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationItemDetail.yaml @@ -0,0 +1,47 @@ +type: object +properties: + identityId: + type: string + format: UUID + description: Identity ID for the recommendation + example: 2c91808570313110017040b06f344ec9 + access: + type: object + properties: + id: + type: string + format: UUID + description: ID of access item being recommended. + example: 2c9180835d2e5168015d32f890ca1581 + type: + $ref: './AccessRequestRecommendationItemType.yaml' + name: + type: string + description: Name of the access item + example: Employee-database-read-write + description: + type: string + description: Description of the access item + example: This item grants an employee read and write access to the database + ignored: + type: boolean + example: true + description: Whether or not the identity has already chosen to ignore this recommendation. + requested: + type: boolean + example: true + description: Whether or not the identity has already chosen to request this recommendation. + viewed: + type: boolean + example: true + description: Whether or not the identity reportedly viewed this recommendation. + messages: + type: array + items: + $ref: './AccessRecommendationMessage.yaml' + translationMessages: + description: The list of translation messages + type: array + example: [{key: recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH, values: ["75","department"]}] + items: + $ref: './TranslationMessage.yaml' diff --git a/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationItemType.yaml b/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationItemType.yaml new file mode 100644 index 000000000..9ec43948c --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationItemType.yaml @@ -0,0 +1,4 @@ +type: string +enum: [ACCESS_PROFILE, ROLE] +description: The type of access item. +example: ACCESS_PROFILE diff --git a/static/api-specs/idn/v2025/schemas/AccessRequestResponse.yaml b/static/api-specs/idn/v2025/schemas/AccessRequestResponse.yaml new file mode 100644 index 000000000..2d4c05f1d --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessRequestResponse.yaml @@ -0,0 +1,26 @@ +type: object +properties: + requesterId: + type: string + example: 2c91808a77ff216301782327a50f09bf + description: the requester Id + requesterName: + type: string + example: Bing C + description: the requesterName + items: + type: array + example: + - operation: Add + accessItemType: role + name: Role-1 + decision: APPROVED + description: The role descrition + sourceId: 8a80828f643d484f01643e14202e206f + sourceName: Source1 + approvalInfos: + - name: John Snow + id: 8a80828f643d484f01643e14202e2000 + status: Approved + items: + $ref: './AccessRequestItemResponse.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/AccessRequestType.yaml b/static/api-specs/idn/v2025/schemas/AccessRequestType.yaml new file mode 100644 index 000000000..b10d86527 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessRequestType.yaml @@ -0,0 +1,10 @@ +type: string +enum: + - GRANT_ACCESS + - REVOKE_ACCESS + - null +description: >- + Access request type. Defaults to GRANT_ACCESS. + REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field. +example: GRANT_ACCESS +nullable: true diff --git a/static/api-specs/idn/v2025/schemas/AccessRequested.yaml b/static/api-specs/idn/v2025/schemas/AccessRequested.yaml new file mode 100644 index 000000000..bf1c625e8 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessRequested.yaml @@ -0,0 +1,17 @@ +type: object +properties: + accessRequest: + $ref: './AccessRequestResponse.yaml' + description: the access request details + identityId: + type: string + example: 8a80828f643d484f01643e14202e206f + description: the identity id + eventType: + type: string + example: AccessRequested + description: the event type + dt: + type: string + example: '2019-03-08T22:37:33.901Z' + description: the date of event \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/AccessReviewItem.yaml b/static/api-specs/idn/v2025/schemas/AccessReviewItem.yaml new file mode 100644 index 000000000..965630d3a --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessReviewItem.yaml @@ -0,0 +1,27 @@ +# Replaced by ReviewItem.yaml +# Cannot represent information from a Role Composition Certification Item +type: object +properties: + accessSummary: + $ref: "./AccessSummary.yaml" + identitySummary: + $ref: "./CertificationIdentitySummary.yaml" + id: + type: string + description: The review item's id + example: ef38f94347e94562b5bb8424a56397d8 + completed: + type: boolean + description: Whether the review item is complete + example: false + newAccess: + type: boolean + description: Indicates whether the review item is for new access to a source + example: false + decision: + $ref: "./CertificationDecision.yaml" + comments: + nullable: true + type: string + description: Comments for this review item + example: This user still needs access to this source diff --git a/static/api-specs/idn/v2025/schemas/AccessRolesChangeSegmentAssignments.yaml b/static/api-specs/idn/v2025/schemas/AccessRolesChangeSegmentAssignments.yaml new file mode 100644 index 000000000..3cd9de307 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessRolesChangeSegmentAssignments.yaml @@ -0,0 +1,41 @@ +type: object +description: >- + A request to make segment assignment changes to multiple roles and access-profiles. +required: + - "segmentId" +properties: + segmentId: + type: string + description: The ID of the Segment + example: ab5fc0cd-e021-4b76-96e6-4818df0d73d5 + assignments: + type: array + items: + $ref: './BareReference.yaml' + nullable: true + description: >- + List of references to objects which will be assigned the Segment. All references must be of type ROLE or + ACCESS_PROFILE. If a referenced object is already assigned the Segment, the new assignment will be silently + ignored. However, it is an error for the same object to be referenced in both the *assignments* and *removals* + lists. + example: + - type: "ROLE" + id: "2c918086750a21d701751e71ee121518" + - type: "ACCESS_PROFILE" + id: "2c918086750a2e129f1518161919ecca" + removals: + type: array + items: + $ref: './BareReference.yaml' + nullable: true + description: >- + List of references to objects which will be removed from the Segment. All references must be of type ROLE or + ACCESS_PROFILE. If a referenced object is not assigned the Segment, the new removal will be silently + ignored. However, it is an error for the same object to be referenced in both the *assignments* and *removals* + lists. + example: + - type: "ROLE" + id: "2c918086750a21d701751e71e73a0289" + - type: "ACCESS_PROFILE" + id: "2c91808676fd514b017702bdc826024a" + diff --git a/static/api-specs/idn/v2025/schemas/AccessSummary.yaml b/static/api-specs/idn/v2025/schemas/AccessSummary.yaml new file mode 100644 index 000000000..242ed4f4f --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessSummary.yaml @@ -0,0 +1,25 @@ +# Replaced by ReviewData.yaml +# Cannot represent information for a Role Composition Certification Item +type : object +description: An object holding the access that is being reviewed +properties: + access: + type: object + properties: + type: + description: The type of item being certified + $ref: './DtoType.yaml' + id: + type: string + description: The ID of the item being certified + example: 2c9180867160846801719932c5153fb7 + name: + type: string + description: The name of the item being certified + example: Entitlement for Company Database + entitlement: + $ref: './reviews/ReviewableEntitlement.yaml' + accessProfile: + $ref: './reviews/ReviewableAccessProfile.yaml' + role: + $ref: './reviews/ReviewableRole.yaml' diff --git a/static/api-specs/idn/v2025/schemas/AccessType.yaml b/static/api-specs/idn/v2025/schemas/AccessType.yaml new file mode 100644 index 000000000..3785efeb2 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccessType.yaml @@ -0,0 +1,6 @@ +type: string +enum: + - ONLINE + - OFFLINE +description: Access type of API Client indicating online or offline use +example: "OFFLINE" diff --git a/static/api-specs/idn/v2025/schemas/Account.yaml b/static/api-specs/idn/v2025/schemas/Account.yaml new file mode 100644 index 000000000..adcd25d63 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/Account.yaml @@ -0,0 +1,170 @@ +allOf: + - $ref: "./BaseCommonDto.yaml" + - type: object + required: + - sourceId + - sourceName + - attributes + - authoritative + - disabled + - locked + - nativeIdentity + - systemAccount + - uncorrelated + - manuallyCorrelated + - hasEntitlements + properties: + sourceId: + type: string + example: 2c9180835d2e5168015d32f890ca1581 + description: The unique ID of the source this account belongs to + sourceName: + type: string + nullable: true + example: Employees + description: The display name of the source this account belongs to + identityId: + type: string + example: 2c9180835d2e5168015d32f890ca1581 + description: The unique ID of the identity this account is correlated to + cloudLifecycleState: + type: string + nullable: true + example: active + description: The lifecycle state of the identity this account is correlated to + identityState: + type: string + nullable: true + example: ACTIVE + description: The identity state of the identity this account is correlated to + connectionType: + type: string + nullable: true + example: direct + description: The connection type of the source this account is from + isMachine: + type: boolean + default: false + description: Indicates if the account is of machine type + example: true + recommendation: + allOf: + - $ref: './Recommendation.yaml' + - nullable: true + description: Indicates that the account is currently classified to be one type but is recommended to be a different one + example: + type: MACHINE + method: DISCOVERY + attributes: + type: object + nullable: true + additionalProperties: true + description: The account attributes that are aggregated + example: + firstName: "SailPoint" + lastName: "Support" + displayName: "SailPoint Support" + authoritative: + type: boolean + description: Indicates if this account is from an authoritative source + example: false + description: + type: string + description: A description of the account + nullable: true + example: null + disabled: + type: boolean + description: Indicates if the account is currently disabled + example: false + locked: + type: boolean + description: Indicates if the account is currently locked + example: false + nativeIdentity: + type: string + description: The unique ID of the account generated by the source system + example: "552775" + systemAccount: + type: boolean + example: false + description: If true, this is a user account within IdentityNow. If false, this is an account from a source system. + uncorrelated: + type: boolean + description: Indicates if this account is not correlated to an identity + example: false + uuid: + type: string + description: + The unique ID of the account as determined by the account schema + example: "{b0dce506-d6d4-44d2-8a32-d9a5b21fb175}" + nullable: true + manuallyCorrelated: + type: boolean + description: + Indicates if the account has been manually correlated to an identity + example: false + hasEntitlements: + type: boolean + description: Indicates if the account has entitlements + example: true + identity: + description: The identity this account is correlated to + type: object + properties: + id: + type: string + description: The ID of the identity + example: 2c918084660f45d6016617daa9210584 + type: + type: string + description: The type of object being referenced + enum: + - IDENTITY + example: IDENTITY + name: + type: string + description: display name of identity + example: "John Doe" + sourceOwner: + type: object + nullable: true + description: The owner of the source this account belongs to. + properties: + id: + type: string + description: The ID of the identity + example: 2c918084660f45d6016617daa9210584 + type: + type: string + description: The type of object being referenced + enum: + - IDENTITY + example: IDENTITY + name: + type: string + description: display name of identity + example: "Adam Kennedy" + features: + type: string + description: A string list containing the owning source's features + example: 'ENABLE' + nullable: true + origin: + type: string + nullable: true + enum: + - AGGREGATED + - PROVISIONED + - null + description: The origin of the account either aggregated or provisioned + example: AGGREGATED + ownerIdentity: + allOf: + - $ref: './BaseReferenceDto.yaml' + - description: The identity who owns this account, used only for machine accounts + nullable: true + example: + id: "2c918084660f45d6016617daa9210584" + type: "IDENTITY" + name: "Adam Kennedy" diff --git a/static/api-specs/idn/v2025/schemas/AccountAction.yaml b/static/api-specs/idn/v2025/schemas/AccountAction.yaml new file mode 100644 index 000000000..a2cb5b8af --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccountAction.yaml @@ -0,0 +1,19 @@ +type : object +description: Object for specifying Actions to be performed on a specified list of sources' account. +properties: + action: + example: ENABLE + type: string + description: Describes if action will be enabled or disabled + enum: + - ENABLE + - DISABLE + sourceIds: + type: array + items: + type: string + uniqueItems: true + example: ["2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500"] + description: >- + List of unique source IDs. The sources must have the ENABLE feature or flat file source. + See "/sources" endpoint for source features. diff --git a/static/api-specs/idn/v2025/schemas/AccountActivity.yaml b/static/api-specs/idn/v2025/schemas/AccountActivity.yaml new file mode 100644 index 000000000..54d2b66c0 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccountActivity.yaml @@ -0,0 +1,92 @@ +type: object +properties: + id: + type: string + description: Id of the account activity + example: 2c9180835d2e5168015d32f890ca1581 + name: + type: string + description: The name of the activity + example: 2c9180835d2e5168015d32f890ca1581 + created: + description: When the activity was first created + type: string + format: "date-time" + example: "2017-07-11T18:45:37.098Z" + modified: + description: When the activity was last modified + type: string + format: "date-time" + example: "2018-06-25T20:22:28.104Z" + nullable: true + completed: + description: When the activity was completed + type: string + format: "date-time" + nullable: true + example: "2018-10-19T13:49:37.385Z" + completionStatus: + $ref: "./CompletionStatus.yaml" + type: + nullable: true + type: string + example: appRequest + description: | + The type of action the activity performed. Please see the following list of types. This list may grow over time. + + - CloudAutomated + - IdentityAttributeUpdate + - appRequest + - LifecycleStateChange + - AccountStateUpdate + - AccountAttributeUpdate + - CloudPasswordRequest + - Attribute Synchronization Refresh + - Certification + - Identity Refresh + - Lifecycle Change Refresh + + + [Learn more here](https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data). + requesterIdentitySummary: + $ref: "./IdentitySummary.yaml" + targetIdentitySummary: + $ref: "./IdentitySummary.yaml" + errors: + nullable: true + description: A list of error messages, if any, that were encountered. + type: array + items: + type: string + example: + [ + "sailpoint.connector.ConnectorException: java.lang.InterruptedException: + Timeout waiting for response to message 0 from client + 57a4ab97-ab3f-4aef-9fe2-0eaf15c73d26 after 60 seconds.", + ] + warnings: + nullable: true + description: A list of warning messages, if any, that were encountered. + type: array + items: + type: string + example: ["Some warning, another warning"] + items: + nullable: true + type: array + description: Individual actions performed as part of this account activity + items: + $ref: "./AccountActivityItem.yaml" + executionStatus: + $ref: "./ExecutionStatus.yaml" + clientMetadata: + nullable: true + type: object + additionalProperties: + type: string + description: >- + Arbitrary key-value pairs, if any were included in the corresponding + access request + example: + customKey1: custom value 1 + customKey2: custom value 2 diff --git a/static/api-specs/idn/v2025/schemas/AccountActivityApprovalStatus.yaml b/static/api-specs/idn/v2025/schemas/AccountActivityApprovalStatus.yaml new file mode 100644 index 000000000..72fd87c66 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccountActivityApprovalStatus.yaml @@ -0,0 +1,12 @@ +type: string +nullable: true +enum: + - FINISHED + - REJECTED + - RETURNED + - EXPIRED + - PENDING + - CANCELED + - null +example: PENDING +description: The state of an approval status \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/AccountActivityItem.yaml b/static/api-specs/idn/v2025/schemas/AccountActivityItem.yaml new file mode 100644 index 000000000..6a8ec3818 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccountActivityItem.yaml @@ -0,0 +1,68 @@ +type: object +properties: + id: + type: string + description: Item id + example: 48c545831b264409a81befcabb0e3c5a + name: + type: string + description: Human-readable display name of item + example: 48c545831b264409a81befcabb0e3c5a + requested: + type: string + format: "date-time" + description: Date and time item was requested + example: "2017-07-11T18:45:37.098Z" + approvalStatus: + $ref: "./AccountActivityApprovalStatus.yaml" + provisioningStatus: + $ref: "./ProvisioningState.yaml" + requesterComment: + $ref: "./Comment.yaml" + reviewerIdentitySummary: + $ref: "./IdentitySummary.yaml" + reviewerComment: + $ref: "./Comment.yaml" + operation: + $ref: "./AccountActivityItemOperation.yaml" + attribute: + type: string + description: Attribute to which account activity applies + nullable: true + example: detectedRoles + value: + type: string + description: Value of attribute + nullable: true + example: Treasury Analyst [AccessProfile-1529010191212] + nativeIdentity: + nullable: true + type: string + description: + Native identity in the target system to which the account activity applies + example: Sandie.Camero + sourceId: + type: string + description: Id of Source to which account activity applies + example: 2c91808363ef85290164000587130c0c + accountRequestInfo: + $ref: "./AccountRequestInfo.yaml" + clientMetadata: + nullable: true + type: object + additionalProperties: + type: string + description: >- + Arbitrary key-value pairs, if any were included in the corresponding + access request item + example: + customKey1: custom value 1 + customKey2: custom value 2 + removeDate: + nullable: true + type: string + description: + The date the role or access profile or entitlement is no longer assigned to the specified + identity. + format: "date-time" + example: "2020-07-11T00:00:00Z" \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/AccountActivityItemOperation.yaml b/static/api-specs/idn/v2025/schemas/AccountActivityItemOperation.yaml new file mode 100644 index 000000000..f57331768 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccountActivityItemOperation.yaml @@ -0,0 +1,16 @@ +type: string +nullable: true +enum: + - ADD + - CREATE + - MODIFY + - DELETE + - DISABLE + - ENABLE + - UNLOCK + - LOCK + - REMOVE + - SET + - null +description: Represents an operation in an account activity item +example: ADD diff --git a/static/api-specs/idn/v2025/schemas/AccountAggregationStatus.yaml b/static/api-specs/idn/v2025/schemas/AccountAggregationStatus.yaml new file mode 100644 index 000000000..6e495a1ff --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccountAggregationStatus.yaml @@ -0,0 +1,47 @@ +type: object +properties: + start: + type: string + format: date-time + nullable: true + example: '2021-01-31T14:30:05.104Z' + description: When the aggregation started. + status: + type: string + enum: + - STARTED + - ACCOUNTS_COLLECTED + - COMPLETED + - CANCELLED + - RETRIED + - TERMINATED + - NOT_FOUND + example: ACCOUNTS_COLLECTED + description: | + STARTED - Aggregation started, but source account iteration has not completed. + + ACCOUNTS_COLLECTED - Source account iteration completed, but all accounts have not yet been processed. + + COMPLETED - Aggregation completed (*possibly with errors*). + + CANCELLED - Aggregation cancelled by user. + + RETRIED - Aggregation retried because of connectivity issues with the Virtual Appliance. + + TERMINATED - Aggregation marked as failed after 3 tries after connectivity issues with the Virtual Appliance. + totalAccounts: + type: integer + example: 520 + description: >- + The total number of *NEW, CHANGED and DELETED* accounts that need to be processed for this aggregation. This + does not include accounts that were unchanged since the previous aggregation. This can be zero if there were no + new, changed or deleted accounts since the previous aggregation. + *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* + processedAccounts: + type: integer + example: 150 + description: >- + The number of *NEW, CHANGED and DELETED* accounts that have been processed so far. This reflects the number of + accounts that have been processed at the time of the API call, and may increase on subsequent API calls while + the status is ACCOUNTS_COLLECTED. + *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* diff --git a/static/api-specs/idn/v2025/schemas/AccountAttributes.yaml b/static/api-specs/idn/v2025/schemas/AccountAttributes.yaml new file mode 100644 index 000000000..57440176b --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccountAttributes.yaml @@ -0,0 +1,14 @@ +type: object +required: + - attributes +properties: + attributes: + description: The schema attribute values for the account + type: object + additionalProperties: true + example: + city: Austin + displayName: John Doe + userName: jdoe + sAMAccountName: jDoe + mail: john.doe@sailpoint.com diff --git a/static/api-specs/idn/v2025/schemas/AccountAttributesCreate.yaml b/static/api-specs/idn/v2025/schemas/AccountAttributesCreate.yaml new file mode 100644 index 000000000..73f045c8c --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccountAttributesCreate.yaml @@ -0,0 +1,23 @@ +type: object +required: + - attributes +properties: + attributes: + description: The schema attribute values for the account + type: object + required: + - sourceId + properties: + sourceId: + type: string + description: Target source to create an account + example: 34bfcbe116c9407464af37acbaf7a4dc + additionalProperties: + type: string + example: + sourceId: 34bfcbe116c9407464af37acbaf7a4dc + city: Austin + displayName: John Doe + userName: jdoe + sAMAccountName: jDoe + mail: john.doe@sailpoint.com diff --git a/static/api-specs/idn/v2025/schemas/AccountDetails.yaml b/static/api-specs/idn/v2025/schemas/AccountDetails.yaml new file mode 100644 index 000000000..e38523641 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccountDetails.yaml @@ -0,0 +1,77 @@ +description: Account Details +type: object +properties: + id: + description: unique id of this object + type: string + example: 2c91808474683da6017468693c260195 + name: + type: string + accountId: + type: string + example: 4191808474683da6017468693c260195 + description: + type: string + nativeIdentity: + type: string + uuid: + type: string + displayName: + type: string + disabled: + type: boolean + locked: + type: boolean + uncorrelated: + type: boolean + systemAccount: + type: boolean + authoritative: + type: boolean + supportsPasswordChange: + type: boolean + attributes: + type: object + application: + type: object + identity: + type: object + schema: + type: object + pendingAccessRequestIds: + type: array + items: + type: string + features: + type: array + items: + type: string + enum: + - AUTHENTICATE + - COMPOSITE + - DIRECT_PERMISSIONS + - DISCOVER_SCHEMA + - ENABLE + - MANAGER_LOOKUP + - NO_RANDOM_ACCESS + - PROXY + - SEARCH + - TEMPLATE + - UNLOCK + - UNSTRUCTURED_TARGETS + - SHAREPOINT_TARGET + - PROVISIONING + - GROUP_PROVISIONING + - SYNC_PROVISIONING + - PASSWORD + - CURRENT_PASSWORD + - ACCOUNT_ONLY_REQUEST + - ADDITIONAL_ACCOUNT_REQUEST + - NO_AGGREGATION + - GROUPS_HAVE_MEMBERS + - NO_PERMISSIONS_PROVISIONING + - NO_GROUP_PERMISSIONS_PROVISIONING + - NO_UNSTRUCTURED_TARGETS_PROVISIONING + - NO_DIRECT_PERMISSIONS_PROVISIONING + meta: + type: object diff --git a/static/api-specs/idn/v2025/schemas/AccountInfoDto.yaml b/static/api-specs/idn/v2025/schemas/AccountInfoDto.yaml new file mode 100644 index 000000000..47cc4abce --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccountInfoDto.yaml @@ -0,0 +1,14 @@ +type: object +properties: + nativeIdentity: + type: string + description: "The unique ID of the account generated by the source system" + example: "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com" + displayName: + type: string + description: "Display name for this account" + example: "Abby.Smith" + uuid: + type: string + description: "UUID associated with this account" + example: "{ad9fc391-246d-40af-b248-b6556a2b7c01}" diff --git a/static/api-specs/idn/v2025/schemas/AccountRequestInfo.yaml b/static/api-specs/idn/v2025/schemas/AccountRequestInfo.yaml new file mode 100644 index 000000000..be62a8723 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccountRequestInfo.yaml @@ -0,0 +1,14 @@ +type: object +nullable: true +properties: + requestedObjectId: + type: string + description: Id of requested object + example: 2c91808563ef85690164001c31140c0c + requestedObjectName: + type: string + description: Human-readable name of requested object + example: Treasury Analyst + requestedObjectType: + $ref: './RequestableObjectType.yaml' +description: If an account activity item is associated with an access request, captures details of that request. diff --git a/static/api-specs/idn/v2025/schemas/AccountStatusChanged.yaml b/static/api-specs/idn/v2025/schemas/AccountStatusChanged.yaml new file mode 100644 index 000000000..99537a7f5 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccountStatusChanged.yaml @@ -0,0 +1,67 @@ +type: object +properties: + eventType: + type: string + description: the event type + identityId: + type: string + description: the identity id + dt: + type: string + description: the date of event + account: + type: object + properties: + id: + type: string + description: the ID of the account in the database + nativeIdentity: + type: string + description: the native identifier of the account + displayName: + type: string + description: the display name of the account + sourceId: + type: string + description: the ID of the source for this account + sourceName: + type: string + description: the name of the source for this account + entitlementCount: + type: integer + description: the number of entitlements on this account + accessType: + type: string + description: this value is always "account" + statusChange: + type: object + properties: + previousStatus: + type: string + description: the previous status of the account + enum: + - enabled + - disabled + - locked + newStatus: + type: string + description: the new status of the account + enum: + - enabled + - disabled + - locked +example: + account: + id: 2c91808a77ff216301782327a50f09bf + nativeIdentity: 127999 + displayName: Sample Name + sourceId: 8a80828f643d484f01643e14202e206f + sourceName: JDBC Entitlements Source + entitlementCount: 0 + accessType: account + statusChange: + previousStatus: enabled + newStatus: disabled + eventType: AccountStatusChanged + identityId: 8a80828f643d484f01643e14202e206f + date: '2019-03-08T22:37:33.901Z' diff --git a/static/api-specs/idn/v2025/schemas/AccountToggleRequest.yaml b/static/api-specs/idn/v2025/schemas/AccountToggleRequest.yaml new file mode 100644 index 000000000..ae265c633 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccountToggleRequest.yaml @@ -0,0 +1,14 @@ +description: Request used for account enable/disable +type: object +properties: + externalVerificationId: + description: If set, an external process validates that the user wants to proceed with this request. + type: string + example: 3f9180835d2e5168015d32f890ca1581 + forceProvisioning: + description: >- + If set, provisioning updates the account attribute at the source. + This option is used when the account is not synced to ensure the attribute is updated. + Providing 'true' for an unlocked account will add and process 'Unlock' operation by the workflow. + type: boolean + example: false diff --git a/static/api-specs/idn/v2025/schemas/AccountUnlockRequest.yaml b/static/api-specs/idn/v2025/schemas/AccountUnlockRequest.yaml new file mode 100644 index 000000000..e9fdd06cb --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccountUnlockRequest.yaml @@ -0,0 +1,17 @@ +description: Request used for account unlock +type: object +properties: + externalVerificationId: + description: If set, an external process validates that the user wants to proceed with this request. + type: string + example: 3f9180835d2e5168015d32f890ca1581 + unlockIDNAccount: + description: If set, the IDN account is unlocked after the workflow completes. + type: boolean + example: false + forceProvisioning: + description: >- + If set, provisioning updates the account attribute at the source. + This option is used when the account is not synced to ensure the attribute is updated. + type: boolean + example: false diff --git a/static/api-specs/idn/v2025/schemas/AccountUsage.yaml b/static/api-specs/idn/v2025/schemas/AccountUsage.yaml new file mode 100644 index 000000000..eeaffa789 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccountUsage.yaml @@ -0,0 +1,14 @@ +type: object +properties: + date: + type: string + format: date + description: + The first day of the month for which activity is aggregated. + example: '2023-04-21' + count: + type: integer + format: int64 + description: >- + The number of days within the month that the account was active in a source. + example: 10 \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/AccountsAsyncResult.yaml b/static/api-specs/idn/v2025/schemas/AccountsAsyncResult.yaml new file mode 100644 index 000000000..1f33ab0a2 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccountsAsyncResult.yaml @@ -0,0 +1,9 @@ +description: Accounts async response containing details on started async process +required: + - id +type: object +properties: + id: + description: id of the task + type: string + example: 2c91808474683da6017468693c260195 diff --git a/static/api-specs/idn/v2025/schemas/ActivateCampaignOptions.yaml b/static/api-specs/idn/v2025/schemas/ActivateCampaignOptions.yaml new file mode 100644 index 000000000..63c295d5f --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ActivateCampaignOptions.yaml @@ -0,0 +1,9 @@ +type : object +properties: + timeZone: + type: string + description: + The timezone must be in a valid ISO 8601 format. Timezones in ISO 8601 are represented as UTC (represented as 'Z') + or as an offset from UTC. The offset format can be +/-hh:mm, +/-hhmm, or +/-hh. + default: Z + example: -05:00 \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/ActiveInvocation.yaml b/static/api-specs/idn/v2025/schemas/ActiveInvocation.yaml new file mode 100644 index 000000000..7439a2350 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ActiveInvocation.yaml @@ -0,0 +1,18 @@ +type: object +properties: + id: + type: string + description: Invocation ID + example: "bc693f07-e7b6-4553-9626-c25954c58554" + created: + type: string + description: Invocation creation timestamp. String (ISO-8601). + example: "2020-03-27T20:42:14.738Z" + triggerId: + type: string + description: Trigger ID + example: "idn:access-requested" + deadline: + type: string + description: Invocation deadline timestamp. String (ISO-8601). + example: "2020-03-28T20:42:14.738Z" diff --git a/static/api-specs/idn/v2025/schemas/ActivityData.yaml b/static/api-specs/idn/v2025/schemas/ActivityData.yaml new file mode 100644 index 000000000..fcbc78a59 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ActivityData.yaml @@ -0,0 +1,26 @@ +type: object +properties: + source: + $ref: './ActivityDataSource.yaml' + daysActive: + type: integer + description: The number of days between firstActiveDate and lastActiveDate that had any activity recorded + example: 20 + firstActiveDate: + type: string + format: date-time + description: The first date any activity has been recorded + example: '2021-01-11T18:45:37.098Z' + lastActiveDate: + type: string + format: date-time + description: The most recent date any activity has been recorded + example: '2021-04-30T20:14:36.932Z' + status: + type: string + enum: + - SUCCESS + - UNAVAILABLE + - UNMAPPED + - ERROR + description: Describes the result of SaaSManagement activity data retrieval operation for the account diff --git a/static/api-specs/idn/v2025/schemas/ActivityDataSource.yaml b/static/api-specs/idn/v2025/schemas/ActivityDataSource.yaml new file mode 100644 index 000000000..ad89674f2 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ActivityDataSource.yaml @@ -0,0 +1,17 @@ +description: A reference to the source of activity +allOf: + - $ref: './SourceDto.yaml' + - type: object + properties: + integrationType: + type: string + enum: + - DIRECT + - SSO + - UNKNOWN + description: Describes the method used to collect source activity data +example: + - type: 'SOURCE' + id: '2c9180835d191a86015d28455b4b232a' + name: 'GitHub' + integrationType: DIRECT diff --git a/static/api-specs/idn/v2025/schemas/ActivityInsights.yaml b/static/api-specs/idn/v2025/schemas/ActivityInsights.yaml new file mode 100644 index 000000000..a6d79bbe3 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ActivityInsights.yaml @@ -0,0 +1,19 @@ +type: object +description: Insights into account activity +properties: + accountID: + type: string + description: UUID of the account + example: "c4ddd5421d8549f0abd309162cafd3b1" + usageDays: + type: integer + format: int32 + minimum: 0 + maximum: 90 + description: The number of days of activity + example: 45 + usageDaysState: + type: string + enum: [ "COMPLETE", "UNKNOWN" ] + description: Status indicating if the activity is complete or unknown + example: "COMPLETE" \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/AdminReviewReassign.yaml b/static/api-specs/idn/v2025/schemas/AdminReviewReassign.yaml new file mode 100644 index 000000000..f7048ee3f --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AdminReviewReassign.yaml @@ -0,0 +1,27 @@ +type: object +properties: + certificationIds: + description: List of certification IDs to reassign + type: array + items: + type: string + minItems: 1 + maxItems: 250 + example: ['af3859464779471211bb8424a563abc1','af3859464779471211bb8424a563abc2','af3859464779471211bb8424a563abc3'] + reassignTo: + type: object + properties: + id: + type: string + description: The identity ID to which the review is being assigned. + example: ef38f94347e94562b5bb8424a56397d8 + type: + type: string + description: The type of the ID provided. + enum: + - IDENTITY + example: IDENTITY + reason: + type: string + description: Comment to explain why the certification was reassigned + example: 'reassigned for some reason' diff --git a/static/api-specs/idn/v2025/schemas/AggregationState.yaml b/static/api-specs/idn/v2025/schemas/AggregationState.yaml new file mode 100644 index 000000000..6209e2e05 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AggregationState.yaml @@ -0,0 +1,21 @@ +type: object +properties: + start: + type: string + description: The date the Aggregation was started. + format: date-time + example: '2020-12-31T23:58:58.104Z' + end: + type: string + description: The end date of the extraction phase of the aggregation. + format: date-time + example: '2020-12-31T23:59:59.104Z' + deltaState: + type: object + description: The delta state of the source. + example: { + "dc=testautomationad,dc=local": { + "lastDirsyncServer": "10.0.5.127", + "users_cookie":"TVNEUwMACCCB1bgmNdXWAQAAAAAAAAAAKAAAAHFanAAAAAAAAAAAAAAAAABxYq0EAAAAAOFygyM+ sGdPq9aP10eUKNoBAAAAAAAAAAEAAAAAAAAA3XKDIz9wZ0+r1o/XR5Qo2gZjrQQAAAAA" + } + } diff --git a/static/api-specs/idn/v2025/schemas/AirflowDagDto.yaml b/static/api-specs/idn/v2025/schemas/AirflowDagDto.yaml new file mode 100644 index 000000000..3f4711006 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AirflowDagDto.yaml @@ -0,0 +1,30 @@ +type: object +properties: + id: + type: string + description: The ID of the airflow DAG + example: 'airflow-dag-2' + runUrl: + type: string + description: The URL of the airflow DAG run + example: '/admin/airflow/graph?dag_id=airflow-dag-2&execution_date=2020-06-02+17%3A05%3A03%2B00%3A00' + executionDate: + type: string + description: Trigger time of the airflow DAG run + example: '2020-06-02T17:05:03Z' + startDate: + type: string + description: Start time of the airflow DAG run + example: '2020-06-02T17:05:02Z' + lastUpdatedDate: + type: string + description: Last time the airflow DAG was updated + example: '2020-07-02T17:05:02Z' + qualifiers: + type: array + description: Qualifiers related to pipeline + items: + type: string + example: + - 20110909124646 + - 20119093434324 diff --git a/static/api-specs/idn/v2025/schemas/AmsCapability.yaml b/static/api-specs/idn/v2025/schemas/AmsCapability.yaml new file mode 100644 index 000000000..af8adf69f --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AmsCapability.yaml @@ -0,0 +1,45 @@ +type: object +description: Authorization model capability +properties: + id: + type: string + description: ID of the capability. + example: idn:admin + name: + type: string + description: The descriptive name of the capability. + example: IdentityNow Administrator + legacyGroup: + type: string + description: The legacy name for the capability. + example: ORG_ADMIN + adminAssignable: + type: boolean + description: If true, this capability can be assigned by the administrator. If false, this capability cannot be assigned to a user. + example: true + translatedName: + type: string + description: A translated string that can be displayed for the capability with tranlation based on the "Accept-Language" header in the request. + example: Admin + translatedGrant: + type: string + description: A translated string that can be displayed for granting the capability with tranlation based on the "Accept-Language" header in the request. + example: Grant Admin + translatedRemove: + type: string + description: A translated string that can be displayed for removing the capability with tranlation based on the "Accept-Language" header in the request. + example: Remove Admin + rightSets: + description: A list of right sets belonging to this capability. + type: array + items: + $ref: './AmsRightSet.yaml' +required: + - id + - name + - legacyGroup + - rightSets + - adminAssignable + - translatedName + - translatedGrant + - translatedRemove \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/AmsRightSet.yaml b/static/api-specs/idn/v2025/schemas/AmsRightSet.yaml new file mode 100644 index 000000000..d5e35401b --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AmsRightSet.yaml @@ -0,0 +1,26 @@ +type: object +description: Authorization model named set of rights +properties: + id: + type: string + description: ID of the right set + example: sp:config-export-import + name: + type: string + description: The descriptive name of the right set + example: Export/Import configuration + rights: + type: array + items: + type: string + example: sp:config:export + description: A list of rights belonging to this right set + example: >- + [ + "sp:config:export", + "sp:config:import" + ] +required: + - id + - name + - rights \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/ApplicationReference.yaml b/static/api-specs/idn/v2025/schemas/ApplicationReference.yaml new file mode 100644 index 000000000..2e0e51111 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ApplicationReference.yaml @@ -0,0 +1,17 @@ +type: object +properties: + id: + type: string + format: UUID + description: ID of application. + example: 2c9180835d2e5168015d32f890ca1581 + name: + type: string + description: Display name of the application. + example: Applied Research Application + description: + type: string + description: Description of the application. + example: Access to research information, lab results, and schematics + owner: + $ref: './AccessItemOwnerDto.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/Approval.yaml b/static/api-specs/idn/v2025/schemas/Approval.yaml new file mode 100644 index 000000000..24eee2e90 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/Approval.yaml @@ -0,0 +1,100 @@ +type: object +properties: + approvalId: + type: string + example: 38453251-6be2-5f8f-df93-5ce19e295837 + description: The Approval ID + approvers: + type: array + items: + $ref: './ApprovalIdentity.yaml' + description: Object representation of an approver of an approval + createdDate: + type: string + example: 2023-04-12T23:20:50.52Z + description: Date the approval was created + type: + type: string + example: ENTITLEMENT_DESCRIPTIONS + description: Type of approval + name: + type: array + items: + $ref: './ApprovalName.yaml' + description: The name of the approval for a given locale + batchRequest: + type: object + description: The name of the approval for a given locale + $ref: './ApprovalBatch.yaml' + example: + batchId: 38453251-6be2-5f8f-df93-5ce19e295837 + batchSize: 100 + description: + type: array + items: + $ref: './ApprovalDescription.yaml' + description: The description of the approval for a given locale + priority: + type: string + enum: + - HIGH + - MEDIUM + - LOW + example: HIGH + description: The priority of the approval + requester: + type: object + description: Object representation of the requester of the approval + $ref: './ApprovalIdentity.yaml' + example: + id: 85d173e7d57e496569df763231d6deb6a + type: IDENTITY + name: John Doe + comments: + type: array + items: + $ref: './ApprovalComment.yaml' + description: Object representation of a comment on the approval + approvedBy: + type: array + items: + $ref: './ApprovalIdentity.yaml' + description: Array of approvers who have approved the approval + rejectedBy: + type: array + items: + $ref: './ApprovalIdentity.yaml' + description: Array of approvers who have rejected the approval + completedDate: + type: string + example: 2023-04-12T23:20:50.52Z + description: Date the approval was completed + approvalCriteria: + type: string + enum: + - SINGLE + - DOUBLE + - TRIPLE + - QUARTER + - HALF + - ALL + example: SINGLE + description: Criteria that needs to be met for an approval to be marked as approved + status: + type: string + enum: + - PENDING + - APPROVED + - REJECTED + example: PENDING + description: The current status of the approval + additionalAttributes: + type: string + example: "{ \"llm_description\": \"generated description\" }" + description: Json string representing additional attributes known about the object to be approved. + referenceData: + type: array + items: + $ref: './ApprovalReference.yaml' + description: Reference data related to the approval +description: Approval Object diff --git a/static/api-specs/idn/v2025/schemas/ApprovalBatch.yaml b/static/api-specs/idn/v2025/schemas/ApprovalBatch.yaml new file mode 100644 index 000000000..43c271d7d --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ApprovalBatch.yaml @@ -0,0 +1,12 @@ +type: object +properties: + batchId: + type: string + example: 38453251-6be2-5f8f-df93-5ce19e295837 + description: ID of the batch + batchSize: + type: integer + format: int64 + example: 100 + description: How many approvals are going to be in this batch. Defaults to 1 if not provided. +description: Batch properties if an approval is sent via batching. diff --git a/static/api-specs/idn/v2025/schemas/ApprovalComment.yaml b/static/api-specs/idn/v2025/schemas/ApprovalComment.yaml new file mode 100644 index 000000000..1b90a59e8 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ApprovalComment.yaml @@ -0,0 +1,13 @@ +type: object +properties: + author: + $ref: './ApprovalIdentity.yaml' + comment: + type: string + example: Looks good + description: Comment to be left on an approval + createdDate: + type: string + example: 2023-04-12T23:20:50.52Z + description: Date the comment was created +description: Comments Object diff --git a/static/api-specs/idn/v2025/schemas/ApprovalDescription.yaml b/static/api-specs/idn/v2025/schemas/ApprovalDescription.yaml new file mode 100644 index 000000000..e1cd5b53d --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ApprovalDescription.yaml @@ -0,0 +1,11 @@ +type: object +properties: + value: + type: string + example: This access allows viewing and editing of workflow resource + description: The description of what the approval is asking for + locale: + type: string + example: en_US + description: What locale the description of the approval is using +description: The description of what the approval is asking for diff --git a/static/api-specs/idn/v2025/schemas/ApprovalForwardHistory.yaml b/static/api-specs/idn/v2025/schemas/ApprovalForwardHistory.yaml new file mode 100644 index 000000000..7e6fdf20b --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ApprovalForwardHistory.yaml @@ -0,0 +1,38 @@ +type: object +properties: + oldApproverName: + type: string + description: Display name of approver from whom the approval was forwarded. + example: Frank Mir + newApproverName: + type: string + description: Display name of approver to whom the approval was forwarded. + example: Al Volta + comment: + type: string + nullable: true + description: Comment made while forwarding. + example: Forwarding from Frank to Al + modified: + type: string + format: 'date-time' + description: Time at which approval was forwarded. + example: '2019-08-23T18:52:57.398Z' + forwarderName: + type: string + nullable: true + description: Display name of forwarder who forwarded the approval. + example: William Wilson + reassignmentType: + $ref: './ReassignmentType.yaml' + description: >- + The approval reassignment type. + + * MANUAL_REASSIGNMENT: An approval with this reassignment type has been specifically reassigned by the approval task's owner, from their queue to someone else's. + + * AUTOMATIC_REASSIGNMENT: An approval with this reassignment type has been automatically reassigned from another approver's queue, according to that approver's reassignment configuration. The approver's reassignment configuration may be set up to automatically reassign approval tasks for a defined (or possibly open-ended) period of time. + + * AUTO_ESCALATION: An approval with this reassignment type has been automatically reassigned from another approver's queue, according to the request's escalation configuration. For more information about escalation configuration, refer to [Setting Global Reminders and Escalation Policies](https://documentation.sailpoint.com/saas/help/requests/config_emails.html). + + * SELF_REVIEW_DELEGATION: An approval with this reassignment type has been automatically reassigned by the system to prevent self-review. This helps prevent situations like a requester being tasked with approving their own request. For more information about preventing self-review, refer to [Self-review Prevention](https://documentation.sailpoint.com/saas/help/users/work_reassignment.html#self-review-prevention) and [Preventing Self-approval](https://documentation.sailpoint.com/saas/help/requests/config_ap_roles.html#preventing-self-approval). + example: AUTOMATIC_REASSIGNMENT diff --git a/static/api-specs/idn/v2025/schemas/ApprovalIdentity.yaml b/static/api-specs/idn/v2025/schemas/ApprovalIdentity.yaml new file mode 100644 index 000000000..4f03f4b34 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ApprovalIdentity.yaml @@ -0,0 +1,17 @@ +type: object +properties: + id: + type: string + example: 85d173e7d57e496569df763231d6deb6a + description: The identity ID + type: + type: string + enum: + - IDENTITY + example: IDENTITY + description: Indication of what group the identity belongs to. Ie, IDENTITY, GOVERNANCE_GROUP, etc + name: + type: string + example: John Doe + description: Name of the identity +description: Identity Object diff --git a/static/api-specs/idn/v2025/schemas/ApprovalInfoResponse.yaml b/static/api-specs/idn/v2025/schemas/ApprovalInfoResponse.yaml new file mode 100644 index 000000000..23f962e1a --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ApprovalInfoResponse.yaml @@ -0,0 +1,14 @@ +type: object +properties: + id: + type: string + example: 8a80828f643d484f01643e14202e2000 + description: the id of approver + name: + type: string + example: John Snow + description: the name of approver + status: + type: string + example: Approved + description: the status of the approval request \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/ApprovalItemDetails.yaml b/static/api-specs/idn/v2025/schemas/ApprovalItemDetails.yaml new file mode 100644 index 000000000..7d9cc17e5 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ApprovalItemDetails.yaml @@ -0,0 +1,33 @@ +type: object +properties: + id: + type: string + description: The approval item's ID + example: 2c9180835d2e5168015d32f890ca1581 + account: + type: string + description: The account referenced by the approval item + example: john.smith + nullable: true + application: + type: string + description: The name of the application/source + example: Active Directory + name: + type: string + description: The attribute's name + example: emailAddress + nullable: true + operation: + type: string + description: The attribute's operation + example: update + value: + type: string + description: The attribute's value + example: a@b.com + nullable: true + state: + allOf: + - $ref: './WorkItemState.yaml' + - nullable: true diff --git a/static/api-specs/idn/v2025/schemas/ApprovalName.yaml b/static/api-specs/idn/v2025/schemas/ApprovalName.yaml new file mode 100644 index 000000000..0955975eb --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ApprovalName.yaml @@ -0,0 +1,11 @@ +type: object +properties: + value: + type: string + example: Audit DB Access + description: Name of the approval + locale: + type: string + example: en_US + description: What locale the name of the approval is using +description: Approval Name Object diff --git a/static/api-specs/idn/v2025/schemas/ApprovalReference.yaml b/static/api-specs/idn/v2025/schemas/ApprovalReference.yaml new file mode 100644 index 000000000..da38e7d7f --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ApprovalReference.yaml @@ -0,0 +1,11 @@ +type: object +properties: + id: + type: string + example: 64012350-8fd9-4f6c-a170-1fe123683899 + description: Id of the reference object + type: + type: string + example: AccessRequestId + description: What reference object does this ID correspond to +description: Reference objects related to the approval diff --git a/static/api-specs/idn/v2025/schemas/ApprovalReminderAndEscalationConfig.yaml b/static/api-specs/idn/v2025/schemas/ApprovalReminderAndEscalationConfig.yaml new file mode 100644 index 000000000..314e285fb --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ApprovalReminderAndEscalationConfig.yaml @@ -0,0 +1,23 @@ +type : object +properties: + daysUntilEscalation: + type: integer + description: Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation. + format: int32 + example: 0 + nullable: true + daysBetweenReminders: + type: integer + description: Number of days to wait between reminder notifications. + format: int32 + example: 0 + nullable: true + maxReminders: + type: integer + description: Maximum number of reminder notification to send to the reviewer before approval escalation. + format: int32 + minimum: 1 + example: 1 + nullable: true + fallbackApproverRef: + $ref: './IdentityReferenceWithNameAndEmail.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/ApprovalScheme.yaml b/static/api-specs/idn/v2025/schemas/ApprovalScheme.yaml new file mode 100644 index 000000000..764cad69b --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ApprovalScheme.yaml @@ -0,0 +1,12 @@ +type: string +enum: + - APP_OWNER + - SOURCE_OWNER + - MANAGER + - ROLE_OWNER + - ACCESS_PROFILE_OWNER + - ENTITLEMENT_OWNER + - GOVERNANCE_GROUP +description: + Describes the individual or group that is responsible for an approval step. +example: MANAGER diff --git a/static/api-specs/idn/v2025/schemas/ApprovalStatus.yaml b/static/api-specs/idn/v2025/schemas/ApprovalStatus.yaml new file mode 100644 index 000000000..5cf2fd958 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ApprovalStatus.yaml @@ -0,0 +1,9 @@ +type: string +enum: + - APPROVED + - REJECTED + - PENDING + - NOT_READY + - CANCELLED +description: Enum representing the non-employee request approval status +example: APPROVED \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/ApprovalStatusDto.yaml b/static/api-specs/idn/v2025/schemas/ApprovalStatusDto.yaml new file mode 100644 index 000000000..dbe0e1094 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ApprovalStatusDto.yaml @@ -0,0 +1,61 @@ +type: object +properties: + forwarded: + type: boolean + default: false + description: + True if the request for this item was forwarded from one owner to another. + example: false + originalOwner: + type: object + description: Identity of orginal approval owner. + properties: + type: + type: string + description: DTO type of original approval owner's identity. + enum: + - GOVERNANCE_GROUP + - IDENTITY + example: IDENTITY + id: + type: string + description: ID of original approval owner's identity. + example: 2c7180a46faadee4016fb4e018c20642 + name: + type: string + description: Display name of original approval owner. + example: Michael Michaels + currentOwner: + allOf: + - $ref: './AccessItemReviewedBy.yaml' + - nullable: true + modified: + type: string + format: date-time + description: Time at which item was modified. + example: "2019-08-23T18:52:57.398Z" + nullable: true + status: + $ref: "./ManualWorkItemState.yaml" + scheme: + $ref: "./ApprovalScheme.yaml" + errorMessages: + type: array + items: + $ref: "./ErrorMessageDto.yaml" + description: >- + If the request failed, includes any error messages that were generated. + nullable: true + comment: + type: string + description: Comment, if any, provided by the approver. + example: I approve this request + nullable: true + removeDate: + type: string + description: + The date the role or access profile or entitlement is no longer assigned to the specified + identity. + format: "date-time" + example: "2020-07-11T00:00:00Z" + nullable: true diff --git a/static/api-specs/idn/v2025/schemas/ApprovalSummary.yaml b/static/api-specs/idn/v2025/schemas/ApprovalSummary.yaml new file mode 100644 index 000000000..6b2bff756 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ApprovalSummary.yaml @@ -0,0 +1,17 @@ +type: object +properties: + pending: + type: integer + description: The number of pending access requests approvals. + format: int32 + example: 0 + approved: + type: integer + description: The number of approved access requests approvals. + format: int32 + example: 0 + rejected: + type: integer + description: The number of rejected access requests approvals. + format: int32 + example: 0 diff --git a/static/api-specs/idn/v2025/schemas/Argument.yaml b/static/api-specs/idn/v2025/schemas/Argument.yaml new file mode 100644 index 000000000..dbd24004b --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/Argument.yaml @@ -0,0 +1,19 @@ +type: object +nullable: true +properties: + name: + type: string + description: the name of the argument + example: firstName + description: + type: string + nullable: true + description: the description of the argument + example: the first name of the identity + type: + type: string + nullable: true + description: the programmatic type of the argument + example: String +required: + - name diff --git a/static/api-specs/idn/v2025/schemas/AssignedIdentityCountByRole.yaml b/static/api-specs/idn/v2025/schemas/AssignedIdentityCountByRole.yaml new file mode 100644 index 000000000..9ef769347 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AssignedIdentityCountByRole.yaml @@ -0,0 +1,11 @@ +type : object +properties: + roleId: + type: string + description: The role IDs. + example: "3267e61ef284439cba2dc6cc11cf0941" + identityCount: + type: integer + format: int32 + description: The assigned identity count. + example: 23 \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/AssignmentContextDto.yaml b/static/api-specs/idn/v2025/schemas/AssignmentContextDto.yaml new file mode 100644 index 000000000..8b75e01a4 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AssignmentContextDto.yaml @@ -0,0 +1,12 @@ +type: object +properties: + requested: + $ref: "./AccessRequestContext.yaml" + matched: + type: array + items: + $ref: "./RoleMatchDto.yaml" + computedDate: + type: string + description: "Date that the assignment will was evaluated" + example: "Wed Feb 14 10:58:42" diff --git a/static/api-specs/idn/v2025/schemas/AttrSyncSource.yaml b/static/api-specs/idn/v2025/schemas/AttrSyncSource.yaml new file mode 100644 index 000000000..154d52b6f --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AttrSyncSource.yaml @@ -0,0 +1,18 @@ +type: object +description: Target source for attribute synchronization. +properties: + type: + type: string + description: DTO type of target source for attribute synchronization. + enum: + - SOURCE + example: SOURCE + id: + type: string + description: ID of target source for attribute synchronization. + example: 2c9180835d191a86015d28455b4b232a + name: + type: string + nullable: true + description: Human-readable name of target source for attribute synchronization. + example: HR Active Directory diff --git a/static/api-specs/idn/v2025/schemas/AttrSyncSourceAttributeConfig.yaml b/static/api-specs/idn/v2025/schemas/AttrSyncSourceAttributeConfig.yaml new file mode 100644 index 000000000..db0e26ea9 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AttrSyncSourceAttributeConfig.yaml @@ -0,0 +1,25 @@ + +type: object +description: Specification of source attribute sync mapping configuration for an identity attribute +required: + - name + - displayName + - enabled + - target +properties: + name: + type: string + description: Name of the identity attribute + example: email + displayName: + type: string + description: Display name of the identity attribute + example: Email + enabled: + type: boolean + description: Determines whether or not the attribute is enabled for synchronization + example: true + target: + type: string + description: Name of the source account attribute to which the identity attribute value will be synchronized if enabled + example: mail diff --git a/static/api-specs/idn/v2025/schemas/AttrSyncSourceConfig.yaml b/static/api-specs/idn/v2025/schemas/AttrSyncSourceConfig.yaml new file mode 100644 index 000000000..dd734da18 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AttrSyncSourceConfig.yaml @@ -0,0 +1,28 @@ + +type: object +description: Specification of attribute sync configuration for a source +required: + - source + - attributes +properties: + source: + $ref: './AttrSyncSource.yaml' + attributes: + type: array + description: Attribute synchronization configuration for specific identity attributes in the context of a source + items: + $ref: './AttrSyncSourceAttributeConfig.yaml' + example: [ + { + name: 'email', + displayName: 'Email', + enabled: true, + target: 'mail' + }, + { + name: 'firstname', + displayName: 'First Name', + enabled: false, + target: 'givenName' + } + ] diff --git a/static/api-specs/idn/v2025/schemas/AttrSyncTenantAttributeConfig.yaml b/static/api-specs/idn/v2025/schemas/AttrSyncTenantAttributeConfig.yaml new file mode 100644 index 000000000..899b72f81 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AttrSyncTenantAttributeConfig.yaml @@ -0,0 +1,39 @@ + +type: object +description: Specification of tenant attribute sync mapping configuration for an identity attribute +required: + - name + - displayName + - targets +properties: + name: + type: string + description: Name of the identity attribute + example: email + displayName: + type: string + description: Display name of the identity attribute + example: Email + targets: + type: array + description: Collection of source synchronization targets to which the identity attribute values should be synchronized + items: + $ref: './AttrSyncTenantSyncTarget.yaml' + example: [ + { + source: { + type: "SOURCE", + id: "2c9180835d191a86015d28455b4b232a", + name: "Corporate Active Directory" + }, + attribute: "mail" + }, + { + source: { + type: "SOURCE", + id: "2c9180835d191a86015d28455b4b232a", + name: "HR Workday" + }, + attribute: "EMAIL_ADDRESS_WORK" + } + ] diff --git a/static/api-specs/idn/v2025/schemas/AttrSyncTenantConfig.yaml b/static/api-specs/idn/v2025/schemas/AttrSyncTenantConfig.yaml new file mode 100644 index 000000000..cf2d4176f --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AttrSyncTenantConfig.yaml @@ -0,0 +1,28 @@ + +type: object +description: Specification of attribute sync configuration for a tenant +required: + - attributes +properties: + id: + type: string + description: Attribute synchronization configuration ID + example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde + readOnly: true + attributes: + type: array + description: Collection of attribute synchronization configuration for individual identity attributes + items: + $ref: './AttrSyncTenantAttributeConfig.yaml' + created: + type: string + description: Date the attribute synchronization configuration was created. + format: 'date-time' + example: '2019-12-24T22:32:58.104Z' + readOnly: true + modified: + type: string + description: Date the attribute synchronization configuration was last modified. + format: 'date-time' + example: '2019-12-31T20:22:28.104Z' + readOnly: true diff --git a/static/api-specs/idn/v2025/schemas/AttrSyncTenantSyncTarget.yaml b/static/api-specs/idn/v2025/schemas/AttrSyncTenantSyncTarget.yaml new file mode 100644 index 000000000..453cfe1f1 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AttrSyncTenantSyncTarget.yaml @@ -0,0 +1,9 @@ + +type: object +properties: + source: + $ref: './AttrSyncSource.yaml' + attribute: + type: string + description: Name of the source account attribute to which the identity attribute values should be synchronized + example: mail diff --git a/static/api-specs/idn/v2025/schemas/AttributeChange.yaml b/static/api-specs/idn/v2025/schemas/AttributeChange.yaml new file mode 100644 index 000000000..bde74ca82 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AttributeChange.yaml @@ -0,0 +1,15 @@ +type: object +properties: + name: + type: string + description: the attribute name + previousValue: + type: string + description: the old value of attribute + newValue: + type: string + description: the new value of attribute +example: + name: firstname + previousValue: adam + newValue: zampa \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/AttributeDefinition.yaml b/static/api-specs/idn/v2025/schemas/AttributeDefinition.yaml new file mode 100644 index 000000000..1880d6ddc --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AttributeDefinition.yaml @@ -0,0 +1,50 @@ +type: object +properties: + name: + type: string + description: The name of the attribute. + example: sAMAccountName + type: + $ref: "./AttributeDefinitionType.yaml" + description: The type of the attribute. + example: STRING + schema: + description: A reference to the schema on the source to the attribute values map to. + type: object + nullable: true + properties: + type: + description: The type of object being referenced + type: string + enum: + - CONNECTOR_SCHEMA + example: CONNECTOR_SCHEMA + id: + type: string + description: The object ID this reference applies to. + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: The human-readable display name of the object. + example: group + description: + type: string + description: A human-readable description of the attribute. + example: SAM Account Name + isMulti: + type: boolean + description: Flag indicating whether or not the attribute is multi-valued. + example: false + default: false + isEntitlement: + type: boolean + description: Flag indicating whether or not the attribute is an entitlement. + example: false + default: false + isGroup: + type: boolean + description: | + Flag indicating whether or not the attribute represents a group. + This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute.. + example: false + default: false \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/AttributeDefinitionType.yaml b/static/api-specs/idn/v2025/schemas/AttributeDefinitionType.yaml new file mode 100644 index 000000000..a5f1e0759 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AttributeDefinitionType.yaml @@ -0,0 +1,9 @@ +type: string +enum: + - STRING + - LONG + - INT + - BOOLEAN +description: + The underlying type of the value which an AttributeDefinition represents. +example: STRING diff --git a/static/api-specs/idn/v2025/schemas/AttributesChanged.yaml b/static/api-specs/idn/v2025/schemas/AttributesChanged.yaml new file mode 100644 index 000000000..c6409a209 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AttributesChanged.yaml @@ -0,0 +1,23 @@ +type: object +properties: + changes: + type: array + items: + $ref: './AttributeChange.yaml' + eventType: + type: string + description: the event type + identityId: + type: string + description: the identity id + dt: + type: string + description: the date of event +example: + attributeChanges: + name: firstname + previousValue: adam + newValue: zampa + eventType: AttributesChanged + identityId: 8a80828f643d484f01643e14202e206f + dt: '2019-03-08T22:37:33.901Z' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/AuthOrgConfiguration.yaml b/static/api-specs/idn/v2025/schemas/AuthOrgConfiguration.yaml new file mode 100644 index 000000000..6f31f1c09 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AuthOrgConfiguration.yaml @@ -0,0 +1,17 @@ +type: object +properties: + enabled: + type: boolean + tenant: + type: string + description: This is the tenant's or organization's name. + serviceProviderConfig: + $ref: 'ServiceProviderConfiguration.yaml' + lockoutConfig: + $ref: 'LockoutConfiguration.yaml' + networkConfig: + $ref: 'NetworkConfiguration.yaml' + orgConfig: + $ref: 'OrgConfiguration.yaml' + sessionConfig: + $ref: 'SessionConfiguration.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/AuthProfile.yaml b/static/api-specs/idn/v2025/schemas/AuthProfile.yaml new file mode 100644 index 000000000..a7797c31f --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AuthProfile.yaml @@ -0,0 +1,40 @@ +type: object +properties: + name: + type: string + description: Authentication Profile name. + example: EndToEnd-Profile + offNetwork: + type: boolean + description: Use it to block access from off network. + default: false + example: true + untrustedGeography: + type: boolean + description: Use it to block access from untrusted geoographies. + default: false + example: true + applicationId: + type: string + nullable: true + description: Application ID. + example: 2c91808458ae7a4f0158b1bbf8af0628 + applicationName: + type: string + nullable: true + description: Application name. + example: EndToEnd-Source + type: + type: string + enum: + - BLOCK + - MFA + - NON_PTA + - PTA + description: Type of the Authentication Profile. + example: PTA + strongAuthLogin: + type: boolean + description: Use it to enable strong authentication. + default: false + example: true diff --git a/static/api-specs/idn/v2025/schemas/AuthProfileRequest.yaml b/static/api-specs/idn/v2025/schemas/AuthProfileRequest.yaml new file mode 100644 index 000000000..d308667cd --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AuthProfileRequest.yaml @@ -0,0 +1,38 @@ +type: object +properties: + name: + type: string + description: Authentication Profile name. + example: EndToEnd-Profile + offNetwork: + type: boolean + description: Use it to block access from off network. + default: false + example: true + untrustedGeography: + type: boolean + description: Use it to block access from untrusted geoographies. + default: false + example: true + applicationId: + type: string + description: Application ID. + example: 2c91808458ae7a4f0158b1bbf8af0628 + applicationName: + type: string + description: Application name. + example: EndToEnd-Source + type: + type: string + enum: + - BLOCK + - MFA + - NON_PTA + - PTA + description: Type of the Authentication Profile. + example: PTA + strongAuthLogin: + type: boolean + description: Use it to enable strong authentication. + default: false + example: true diff --git a/static/api-specs/idn/v2025/schemas/AuthProfileSummary.yaml b/static/api-specs/idn/v2025/schemas/AuthProfileSummary.yaml new file mode 100644 index 000000000..b180db3b2 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AuthProfileSummary.yaml @@ -0,0 +1,11 @@ +type: object +properties: + tenant: + type: string + description: Tenant name. + example: "test-tenant" + id: + type: string + description: Identity ID. + example: 2c91808458ae7a4f0158b1bbf8af0628 + diff --git a/static/api-specs/idn/v2025/schemas/AuthSupportLoginRequest.yaml b/static/api-specs/idn/v2025/schemas/AuthSupportLoginRequest.yaml new file mode 100644 index 000000000..2a38b5de0 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AuthSupportLoginRequest.yaml @@ -0,0 +1,12 @@ +type: object +properties: + authTenant: + type: string + description: The tenant providing support (can't be the same as request tenant) + default: sailpoint + example: sailpoint + expirationDate: + type: string + format: date-time + description: When the auth support login access expires. (must be within a year's time from when the auth support login is created or updated) + example: "2019-08-23T18:52:59.162Z" diff --git a/static/api-specs/idn/v2025/schemas/AuthSupportLoginResponse.yaml b/static/api-specs/idn/v2025/schemas/AuthSupportLoginResponse.yaml new file mode 100644 index 000000000..f4afea5e4 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AuthSupportLoginResponse.yaml @@ -0,0 +1,29 @@ +type: object +properties: + authTenant: + type: string + description: The tenant providing support. + example: sailpoint + authUserName: + type: string + description: The username in the target tenant that the authTenant's support and services user will log in as. + example: slpt.services + role: + type: string + description: The user access role in the auth tenant capable of providing admin-level support + example: Support and Services Role + expirationDate: + type: string + format: date-time + description: When the auth support login access expires. + example: "2019-08-23T18:52:59.162Z" + modified: + type: string + format: date-time + description: When the request was last modified. + example: "2019-08-23T18:52:59.162Z" + created: + type: string + format: date-time + description: When the request was created. + example: "2019-08-23T18:40:35.772Z" diff --git a/static/api-specs/idn/v2025/schemas/AuthSupportTenantRequest.yaml b/static/api-specs/idn/v2025/schemas/AuthSupportTenantRequest.yaml new file mode 100644 index 000000000..cfaddbe56 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AuthSupportTenantRequest.yaml @@ -0,0 +1,10 @@ +type: object +properties: + authUserName: + type: string + description: The username in the target tenant that the authTenant's support and services user will log in as. + example: slpt.services + role: + type: string + description: The user access role in the auth tenant capable of providing admin-level support + example: Support and Services Role diff --git a/static/api-specs/idn/v2025/schemas/AuthSupportTenantResponse.yaml b/static/api-specs/idn/v2025/schemas/AuthSupportTenantResponse.yaml new file mode 100644 index 000000000..943083ecf --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AuthSupportTenantResponse.yaml @@ -0,0 +1,24 @@ +type: object +properties: + authTenant: + type: string + description: The tenant providing support. + example: sailpoint + authUserName: + type: string + description: The username in the target tenant that the authTenant's support and services user will log in as. + example: slpt.services + role: + type: string + description: The user access role in the auth tenant capable of providing admin-level support + example: Support and Services Role + modified: + type: string + format: date-time + description: When the request was last modified. + example: "2019-08-23T18:52:59.162Z" + created: + type: string + format: date-time + description: When the request was created. + example: "2019-08-23T18:40:35.772Z" diff --git a/static/api-specs/idn/v2025/schemas/AuthSupportTransferStatusResponse.yaml b/static/api-specs/idn/v2025/schemas/AuthSupportTransferStatusResponse.yaml new file mode 100644 index 000000000..5824cd6de --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AuthSupportTransferStatusResponse.yaml @@ -0,0 +1,20 @@ +type: object +properties: + tenant: + type: string + description: The tenant granting support and services access to DevOps. + example: acme-solar + transferred: + type: boolean + description: The state indicating whether the tenant has been transferred to the customer. + example: true + modified: + type: string + format: date-time + description: When the transfer status was last modified. + example: "2021-05-03T18:52:59.162Z" + created: + type: string + format: date-time + description: When the transfer status was created. + example: "2021-05-03T18:40:35.772Z" diff --git a/static/api-specs/idn/v2025/schemas/AuthSupportUserEligibilityResponse.yaml b/static/api-specs/idn/v2025/schemas/AuthSupportUserEligibilityResponse.yaml new file mode 100644 index 000000000..ee91e5c85 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AuthSupportUserEligibilityResponse.yaml @@ -0,0 +1,5 @@ +type: object +properties: + authSupportUserEligible: + type: boolean + description: True if the logged-in user is eligible to provide admin-level support in a customer org. diff --git a/static/api-specs/idn/v2025/schemas/AuthUser.yaml b/static/api-specs/idn/v2025/schemas/AuthUser.yaml new file mode 100644 index 000000000..e44a3a528 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AuthUser.yaml @@ -0,0 +1,112 @@ +type: object +properties: + tenant: + type: string + description: Tenant name. + example: "test-tenant" + id: + type: string + description: Identity ID. + example: 2c91808458ae7a4f0158b1bbf8af0628 + uid: + type: string + description: Identity's unique identitifier. + example: "will.smith" + profile: + type: string + description: ID of the auth profile associated with the auth user. + example: 2c91808458ae7a4f0158b1bbf8af0756 + identificationNumber: + type: string + description: Auth user's employee number. + example: "19-5588452" + nullable: true + email: + type: string + description: Auth user's email. + example: william.smith@example.com + nullable: true + phone: + type: string + description: Auth user's phone number. + example: "5555555555" + nullable: true + workPhone: + type: string + description: Auth user's work phone number. + example: "5555555555" + nullable: true + personalEmail: + type: string + description: Auth user's personal email. + example: william.smith@example.com + nullable: true + firstname: + type: string + description: Auth user's first name. + example: Will + nullable: true + lastname: + type: string + description: Auth user's last name. + example: Smith + nullable: true + displayName: + type: string + description: Auth user's name in displayed format. + example: Will Smith + alias: + type: string + description: Auth user's alias. + example: will.smith + lastPasswordChangeDate: + type: string + format: date-time + description: Date of last password change. + example: "2021-03-08T22:37:33.901Z" + nullable: true + lastLoginTimestamp: + description: Timestamp of the last login (long type value). + type: integer + format: int64 + example: 1656327185832 + currentLoginTimestamp: + description: Timestamp of the current login (long type value). + type: integer + format: int64 + example: 1656327185832 + lastUnlockTimestamp: + type: string + format: date-time + description: The date and time when the user was last unlocked. + example: "2021-03-08T22:37:33.901Z" + nullable: true + capabilities: + description: Array of the auth user's capabilities. + type: array + nullable: true + items: + type: string + enum: + - CERT_ADMIN + - CLOUD_GOV_ADMIN + - CLOUD_GOV_USER + - HELPDESK + - ORG_ADMIN + - REPORT_ADMIN + - ROLE_ADMIN + - ROLE_SUBADMIN + - SAAS_MANAGEMENT_ADMIN + - SAAS_MANAGEMENT_READER + - SOURCE_ADMIN + - SOURCE_SUBADMIN + - das:ui-administrator + - das:ui-compliance_manager + - das:ui-auditor + - das:ui-data-scope + - sp:aic-dashboard-read + - sp:aic-dashboard-write + - sp:ui-config-hub-admin + - sp:ui-config-hub-backup-admin + - sp:ui-config-hub-read + example: "ORG_ADMIN" diff --git a/static/api-specs/idn/v2025/schemas/AuthUserSaveRequest.yaml b/static/api-specs/idn/v2025/schemas/AuthUserSaveRequest.yaml new file mode 100644 index 000000000..a9228057c --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AuthUserSaveRequest.yaml @@ -0,0 +1,52 @@ +type: object +properties: + uid: + type: string + description: Identity unique identitifier. + example: "will.smith" + profile: + type: string + description: ID of the auth profile associated with this auth user. + example: 2c91808458ae7a4f0158b1bbf8af0756 + identificationNumber: + type: string + description: Auth user employee number. + example: "19-5588452" + email: + type: string + description: Auth user's email. + example: william.smith@example.com + phone: + type: string + description: Auth user's phone number. + example: "5555555555" + workPhone: + type: string + description: Auth user's work phone number. + example: "5555555555" + personalEmail: + type: string + description: Auth user's personal email. + example: william.smith@example.com + firstname: + type: string + description: Auth user's first name. + example: Will + lastname: + type: string + description: Auth user's last name. + example: Smith + displayName: + type: string + description: Auth user's name in displayed format. + example: Will Smith + alias: + type: string + description: Auth user's alias. + example: will.smith + capabilities: + description: Array of capabilities for this auth user. + type: array + items: + type: string + example: "ORG_ADMIN" diff --git a/static/api-specs/idn/v2025/schemas/AuthenticationType.yaml b/static/api-specs/idn/v2025/schemas/AuthenticationType.yaml new file mode 100644 index 000000000..8d1ae80f7 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AuthenticationType.yaml @@ -0,0 +1,6 @@ +description: type of authentication to use for the Service Desk integration. Normally the values would be all caps, but they're not for backward compatibility. +type: string +example: Basic +enum: + - Basic + - OAuth2 diff --git a/static/api-specs/idn/v2025/schemas/BareReference.yaml b/static/api-specs/idn/v2025/schemas/BareReference.yaml new file mode 100644 index 000000000..c7553defa --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/BareReference.yaml @@ -0,0 +1,11 @@ +type: object +properties: + type: + $ref: './DtoType.yaml' + description: DTO type + example: IDENTITY + id: + type: string + description: ID of the object to which this reference applies + example: 2c91808568c529c60168cca6f90c1313 + diff --git a/static/api-specs/idn/v2025/schemas/BaseCommonDto.yaml b/static/api-specs/idn/v2025/schemas/BaseCommonDto.yaml new file mode 100644 index 000000000..e7af93970 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/BaseCommonDto.yaml @@ -0,0 +1,26 @@ +type: object +required: + - name +properties: + id: + description: System-generated unique ID of the Object + type: string + example: id12345 + readOnly: true + name: + description: Name of the Object + type: string + example: aName + nullable: true + created: + description: Creation date of the Object + type: string + example: "2015-05-28T14:07:17Z" + format: date-time + readOnly: true + modified: + description: Last modification date of the Object + type: string + example: "2015-05-28T14:07:17Z" + format: date-time + readOnly: true diff --git a/static/api-specs/idn/v2025/schemas/BaseReferenceDto.yaml b/static/api-specs/idn/v2025/schemas/BaseReferenceDto.yaml new file mode 100644 index 000000000..fe84b107c --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/BaseReferenceDto.yaml @@ -0,0 +1,13 @@ +type: object +properties: + type: + $ref: './DtoType.yaml' + description: DTO type + id: + type: string + description: ID of the object to which this reference applies + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Human-readable display name of the object to which this reference applies + example: William Wilson \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/BasicAuthConfig.yaml b/static/api-specs/idn/v2025/schemas/BasicAuthConfig.yaml new file mode 100644 index 000000000..bec9a86d8 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/BasicAuthConfig.yaml @@ -0,0 +1,13 @@ +type: object +properties: + userName: + type: string + description: The username to authenticate. + example: "user@example.com" + password: + type: string + nullable: true + description: The password to authenticate. On response, this field is set to null as to not return secrets. + example: null +nullable: true +description: Config required if BASIC_AUTH is used. diff --git a/static/api-specs/idn/v2025/schemas/BasicProvision.yaml b/static/api-specs/idn/v2025/schemas/BasicProvision.yaml new file mode 100644 index 000000000..da35e0702 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/BasicProvision.yaml @@ -0,0 +1,26 @@ +description: This contains the common properties for provisioning of incident, change request, or service request tickets to the Ticketing System. +required: + - request +type: object +properties: + request: + description: A request payload attributes map used to create a manual fulfillment ticket to the Ticketing System. + type: object + additionalProperties: true + example: + description: SailPoint Access Request, + req_description: The Service Request created by SailPoint ServiceNow Service Integration Module (SIM)., + req_short_description: SailPoint New Access Request Created from IdentityNow, + short_description: SailPoint Access Request $!plan.arguments.identityRequestId + requestRootElement: + description: The outermost level of the JSON element or root of a request. Optional in some Service Desk Integrations. + type: string + example: items + resource: + description: The resource URL to use to create a ticket in the Ticketing System, not including the base URL prefix. + type: string + example: /api/x_sap_sdim/sailpoint_cart_js_api/create_ticket + responseElement: + description: A JSON path expression, specifying where to obtain ticket status from a REST response. + type: string + example: result.state diff --git a/static/api-specs/idn/v2025/schemas/BearerTokenAuthConfig.yaml b/static/api-specs/idn/v2025/schemas/BearerTokenAuthConfig.yaml new file mode 100644 index 000000000..8f932a8e1 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/BearerTokenAuthConfig.yaml @@ -0,0 +1,10 @@ +type: object +properties: + bearerToken: + type: string + nullable: true + description: Bearer token + example: null +nullable: true +description: Config required if BEARER_TOKEN authentication is used. On response, this field is set to null as to not return secrets. + diff --git a/static/api-specs/idn/v2025/schemas/BeforeProvisioningRuleDto.yaml b/static/api-specs/idn/v2025/schemas/BeforeProvisioningRuleDto.yaml new file mode 100644 index 000000000..e0f34497b --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/BeforeProvisioningRuleDto.yaml @@ -0,0 +1,17 @@ +type: object +description: Before Provisioning Rule. +properties: + type: + type: string + description: Before Provisioning Rule DTO type. + enum: + - RULE + example: RULE + id: + type: string + description: Before Provisioning Rule ID. + example: 048eb3d55c5a4758bd07dccb87741c78 + name: + type: string + description: Rule display name. + example: Before Provisioning Airtable Rule diff --git a/static/api-specs/idn/v2025/schemas/BrandingItem.yaml b/static/api-specs/idn/v2025/schemas/BrandingItem.yaml new file mode 100644 index 000000000..dc91265ff --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/BrandingItem.yaml @@ -0,0 +1,41 @@ +type: object +properties: + name: + type: string + description: name of branding item + example: "default" + productName: + type: string + description: product name + example: "product name" + nullable: true + actionButtonColor: + type: string + description: hex value of color for action button + example: "0074D9" + nullable: true + activeLinkColor: + type: string + description: hex value of color for link + example: "011E69" + nullable: true + navigationColor: + type: string + description: hex value of color for navigation bar + example: "011E69" + nullable: true + emailFromAddress: + type: string + description: email from address + example: "no-reply@sailpoint.com" + nullable: true + standardLogoURL: + type: string + description: url to standard logo + example: "" + nullable: true + loginInformationalMessage: + type: string + description: login information message + example: "" + nullable: true diff --git a/static/api-specs/idn/v2025/schemas/BrandingItemCreate.yaml b/static/api-specs/idn/v2025/schemas/BrandingItemCreate.yaml new file mode 100644 index 000000000..49bd83b57 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/BrandingItemCreate.yaml @@ -0,0 +1,39 @@ +type: object +required: + - name + - productName +properties: + name: + type: string + description: name of branding item + example: "custom-branding-item" + productName: + type: string + description: product name + example: "product name" + nullable: true + actionButtonColor: + type: string + description: hex value of color for action button + example: "0074D9" + activeLinkColor: + type: string + description: hex value of color for link + example: "011E69" + navigationColor: + type: string + description: hex value of color for navigation bar + example: "011E69" + emailFromAddress: + type: string + description: email from address + example: "no-reply@sailpoint.com" + loginInformationalMessage: + type: string + description: login information message + example: "" + fileStandard: + type: string + format: binary + description: png file with logo + example: \x00\x00\x00\x02 diff --git a/static/api-specs/idn/v2025/schemas/BulkAddTaggedObject.yaml b/static/api-specs/idn/v2025/schemas/BulkAddTaggedObject.yaml new file mode 100644 index 000000000..fc29c8910 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/BulkAddTaggedObject.yaml @@ -0,0 +1,24 @@ +type: object +properties: + objectRefs: + type: array + items: + $ref: './TaggedObjectDto.yaml' + tags: + type: array + items: + type: string + description: Label to be applied to an Object + example: [ "BU_FINANCE", "PCI" ] + operation: + type: string + enum: + - APPEND + - MERGE + default: APPEND + description: >- + If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object. + + + If MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored. + example: MERGE diff --git a/static/api-specs/idn/v2025/schemas/BulkApproveAccessRequest.yaml b/static/api-specs/idn/v2025/schemas/BulkApproveAccessRequest.yaml new file mode 100644 index 000000000..9b5f73844 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/BulkApproveAccessRequest.yaml @@ -0,0 +1,17 @@ +type : object +description: Request body payload for bulk approve access request endpoint. +required : + - approvalIds + - comment +properties: + approvalIds: + type: array + description: List of approval ids to approve the pending requests + items: + type: string + example: [2c9180835d2e5168015d32f890ca1581, 2c9180835d2e5168015d32f890ca1582] + + comment: + type: string + description: Reason for approving the pending access request. + example: "I approve these request items" \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/BulkCancelAccessRequest.yaml b/static/api-specs/idn/v2025/schemas/BulkCancelAccessRequest.yaml new file mode 100644 index 000000000..3e0c6f8c9 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/BulkCancelAccessRequest.yaml @@ -0,0 +1,17 @@ +type : object +description: Request body payload for bulk cancel access request endpoint. +required : + - accessRequestIds + - comment +properties: + accessRequestIds: + type: array + description: List of access requests ids to cancel the pending requests + items: + type: string + example: [2c9180835d2e5168015d32f890ca1581, 2c9180835d2e5168015d32f890ca1582] + + comment: + type: string + description: Reason for cancelling the pending access request. + example: "I requested this role by mistake." \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/BulkIdentitiesAccountsResponse.yaml b/static/api-specs/idn/v2025/schemas/BulkIdentitiesAccountsResponse.yaml new file mode 100644 index 000000000..2a5bf7859 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/BulkIdentitiesAccountsResponse.yaml @@ -0,0 +1,17 @@ +type: object +description: Bulk response object. +properties: + id: + type: string + description: Identifier of bulk request item. + example: 2c9180858082150f0180893dbaf553fe + statusCode: + type: integer + format: int32 + description: Response status value. + example: 404 + message: + type: string + description: Status containing additional context information about failures. + example: Referenced identity "2c9180858082150f0180893dbaf553fe" was not found. + diff --git a/static/api-specs/idn/v2025/schemas/BulkRemoveTaggedObject.yaml b/static/api-specs/idn/v2025/schemas/BulkRemoveTaggedObject.yaml new file mode 100644 index 000000000..36044e418 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/BulkRemoveTaggedObject.yaml @@ -0,0 +1,12 @@ +type: object +properties: + objectRefs: + type: array + items: + $ref: './TaggedObjectDto.yaml' + tags: + type: array + items: + type: string + description: Label to be applied to an Object + example: [ "BU_FINANCE", "PCI" ] diff --git a/static/api-specs/idn/v2025/schemas/BulkTaggedObject.yaml b/static/api-specs/idn/v2025/schemas/BulkTaggedObject.yaml new file mode 100644 index 000000000..15d3c6373 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/BulkTaggedObject.yaml @@ -0,0 +1,24 @@ +type: object +properties: + objectRefs: + type: array + items: + $ref: './TaggedObjectDto.yaml' + tags: + type: array + items: + type: string + description: Label to be applied to object. + example: [ "BU_FINANCE", "PCI" ] + operation: + type: string + enum: + - APPEND + - MERGE + default: APPEND + description: >- + If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object. + + + If MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored. + example: MERGE diff --git a/static/api-specs/idn/v2025/schemas/BulkTaggedObjectResponse.yaml b/static/api-specs/idn/v2025/schemas/BulkTaggedObjectResponse.yaml new file mode 100644 index 000000000..36044e418 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/BulkTaggedObjectResponse.yaml @@ -0,0 +1,12 @@ +type: object +properties: + objectRefs: + type: array + items: + $ref: './TaggedObjectDto.yaml' + tags: + type: array + items: + type: string + description: Label to be applied to an Object + example: [ "BU_FINANCE", "PCI" ] diff --git a/static/api-specs/idn/v2025/schemas/BulkUpdateAuthUser.yaml b/static/api-specs/idn/v2025/schemas/BulkUpdateAuthUser.yaml new file mode 100644 index 000000000..11f5435e7 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/BulkUpdateAuthUser.yaml @@ -0,0 +1,28 @@ +type: object +properties: + authUserPatches: + description: >- + Map of id of the auth user to a JsonPatchOperation describing what to patch on that auth user. + type: object + additionalProperties: + $ref: './JsonPatchOperation.yaml' + example: { + "2c91808d7b98f877017ba8263dc07d54": [ + { + "op": "replace", + "path": "/capabilities", + "value": [ + "ORG_ADMIN" + ] + } + ], + "2c91808d7b98f877017ba8263dd77d5c": [ + { + "op": "replace", + "path": "/capabilities", + "value": [ + "ORG_ADMIN" + ] + } + ] + } diff --git a/static/api-specs/idn/v2025/schemas/Campaign.yaml b/static/api-specs/idn/v2025/schemas/Campaign.yaml new file mode 100644 index 000000000..a4b38da13 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/Campaign.yaml @@ -0,0 +1,252 @@ +type : object +title: Campaign +allOf: + - $ref: 'SlimCampaign.yaml' + - type: object + properties: + modified: + type: string + readOnly: true + nullable: true + format: date-time + description: Modified time of the campaign + example: '2020-03-03T22:20:12.674Z' + filter: + type: object + nullable: true + description: >- + Determines which items will be included in this campaign. The default campaign filter is used if this + field is left blank. + properties: + id: + type: string + description: The ID of whatever type of filter is being used. + example: 0fbe863c063c4c88a35fd7f17e8a3df5 + type: + type: string + description: Type of the filter + enum: + - CAMPAIGN_FILTER + - RULE + example: CAMPAIGN_FILTER + name: + type: string + description: Name of the filter + example: Test Filter + sunsetCommentsRequired: + type: boolean + description: >- + Determines if comments on sunset date changes are required. + default: true + example: true + sourceOwnerCampaignInfo: + type: object + nullable: true + description: Must be set only if the campaign type is SOURCE_OWNER. + properties: + sourceIds: + type: array + description: The list of sources to be included in the campaign. + items: + type: string + example: [0fbe863c063c4c88a35fd7f17e8a3df5] + searchCampaignInfo: + type: object + nullable: true + description: Must be set only if the campaign type is SEARCH. + properties: + type: + type: string + description: The type of search campaign represented. + enum: + - IDENTITY + - ACCESS + example: ACCESS + description: + type: string + description: >- + Describes this search campaign. Intended for storing the query used, and possibly the number of identities + selected/available. + example: Search Campaign description + reviewer: + type: object + nullable: true + description: >- + If specified, this identity or governance group will be the reviewer for all certifications in + this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP. + properties: + type: + type: string + description: The reviewer's DTO type. + enum: + - GOVERNANCE_GROUP + - IDENTITY + example: IDENTITY + id: + type: string + description: The reviewer's ID. + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + nullable: true + description: The reviewer's name. + example: William Wilson + query: + type: string + nullable: true + description: >- + The scope for the campaign. The campaign will cover identities returned by the query and identities that + have access items returned by the query. One of `query` or `identityIds` must be set. + example: Search Campaign query description + identityIds: + type: array + nullable: true + description: A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set. + items: + type: string + maxItems: 1000 + example: [0fbe863c063c4c88a35fd7f17e8a3df5] + accessConstraints: + type: array + description: >- + Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do + not have this access. + items: + $ref: './AccessConstraint.yaml' + maxItems: 1000 + required: + - type + roleCompositionCampaignInfo: + type: object + nullable: true + description: Optional configuration options for role composition campaigns. + properties: + reviewerId: + type: string + description: The ID of the identity or governance group reviewing this campaign. Deprecated in favor of the "reviewer" object. + deprecated: true + example: 2c91808568c529c60168cca6f90c1313 + nullable: true + reviewer: + type: object + nullable: true + description: >- + If specified, this identity or governance group will be the reviewer for all certifications in + this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP. + properties: + type: + type: string + description: The reviewer's DTO type. + enum: + - GOVERNANCE_GROUP + - IDENTITY + example: IDENTITY + id: + type: string + description: The reviewer's ID. + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: The reviewer's name. + example: William Wilson + roleIds: + type: array + description: >- + Optional list of roles to include in this campaign. Only one of `roleIds` and `query` may be set; if + neither are set, all roles are included. + items: + type: string + example: [2c90ad2a70ace7d50170acf22ca90010] + remediatorRef: + type: object + description: >- + This determines who remediation tasks will be assigned to. Remediation tasks are created for each + revoke decision on items in the campaign. The only legal remediator type is 'IDENTITY', and the + chosen identity must be a Role Admin or Org Admin. + properties: + type: + type: string + enum: + - IDENTITY + description: Legal Remediator Type + example: IDENTITY + id: + type: string + description: The ID of the remediator. + example: 2c90ad2a70ace7d50170acf22ca90010 + name: + type: string + description: The name of the remediator. + readOnly: true + example: Role Admin + required: + - type + - id + query: + type: string + nullable: true + description: >- + Optional search query to scope this campaign to a set of roles. Only one of `roleIds` and `query` may + be set; if neither are set, all roles are included. + example: Search Query + description: + type: string + nullable: true + description: >- + Describes this role composition campaign. Intended for storing the query used, and possibly the number + of roles selected/available. + example: Role Composition Description + required: + - remediatorRef + machineAccountCampaignInfo: + type: object + nullable: true + description: Must be set only if the campaign type is MACHINE_ACCOUNT. + properties: + sourceIds: + type: array + description: The list of sources to be included in the campaign. + items: + type: string + example: [ 0fbe863c063c4c88a35fd7f17e8a3df5 ] + reviewerType: + type: string + description: The reviewer's type. + enum: + - ACCOUNT_OWNER + example: ACCOUNT_OWNER + sourcesWithOrphanEntitlements: + type: array + nullable: true + description: >- + A list of sources in the campaign that contain \"orphan entitlements\" (entitlements without a corresponding + Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may + be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). + readOnly: true + items: + type: object + properties: + id: + type: string + description: Id of the source + example: 2c90ad2a70ace7d50170acf22ca90010 + type: + type: string + enum: + - SOURCE + description: Type + example: SOURCE + name: + type: string + description: Name of the source + example: Source with orphan entitlements + mandatoryCommentRequirement: + type: string + description: >- + Determines whether comments are required for decisions during certification reviews. You can require comments + for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. + enum: + - "ALL_DECISIONS" + - "REVOKE_ONLY_DECISIONS" + - "NO_DECISIONS" + example: NO_DECISIONS diff --git a/static/api-specs/idn/v2025/schemas/CampaignAlert.yaml b/static/api-specs/idn/v2025/schemas/CampaignAlert.yaml new file mode 100644 index 000000000..5f10ea3ff --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/CampaignAlert.yaml @@ -0,0 +1,14 @@ +type : object +properties: + level: + type: string + enum: + - ERROR + - WARN + - INFO + description: Denotes the level of the message + example: ERROR + localizations: + type: array + items: + $ref: './ErrorMessageDto.yaml' diff --git a/static/api-specs/idn/v2025/schemas/CampaignCompleteOptions.yaml b/static/api-specs/idn/v2025/schemas/CampaignCompleteOptions.yaml new file mode 100644 index 000000000..b0f27e7b9 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/CampaignCompleteOptions.yaml @@ -0,0 +1,11 @@ +type: object +properties: + autoCompleteAction: + description: + Determines whether to auto-approve(APPROVE) or auto-revoke(REVOKE) upon campaign completion. + type: string + enum: + - APPROVE + - REVOKE + default: APPROVE + example: REVOKE diff --git a/static/api-specs/idn/v2025/schemas/CampaignFilterDetails.yaml b/static/api-specs/idn/v2025/schemas/CampaignFilterDetails.yaml new file mode 100644 index 000000000..ea44107a1 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/CampaignFilterDetails.yaml @@ -0,0 +1,110 @@ +type: object +description: Campaign Filter Details +properties: + id: + type: string + description: The unique ID of the campaign filter + example: 5ec18cef39020d6fd7a60ad3970aba61 + name: + type: string + description: Campaign filter name. + example: Identity Attribute Campaign Filter + description: + type: string + description: Campaign filter description. + example: Campaign filter to certify data based on an identity attribute's specified property. + owner: + type: string + description: Owner of the filter. This field automatically populates at creation time with the current user. + example: SailPoint Support + nullable: true + mode: + type: string + description: >- + Mode/type of filter, either the INCLUSION or EXCLUSION type. The INCLUSION type includes the data in generated campaigns + as per specified in the criteria, whereas the EXCLUSION type excludes the data in generated campaigns as per specified in criteria. + enum: + - "INCLUSION" + - "EXCLUSION" + example: INCLUSION + criteriaList: + type: array + description: List of criteria. + items: + type: object + properties: + type: + $ref: './CriteriaType.yaml' + operation: + $ref: './Operation.yaml' + property: + type: string + description: Specified key from the type of criteria. + example: displayName + nullable: true + value: + type: string + description: Value for the specified key from the type of criteria. + example: Allie + nullable: true + negateResult: + type: boolean + description: If true, the filter will negate the result of the criteria. + example: false + default: false + shortCircuit: + type: boolean + description: If true, the filter will short circuit the evaluation of the criteria. + example: false + default: false + recordChildMatches: + type: boolean + description: If true, the filter will record child matches for the criteria. + example: false + default: false + id: + type: string + description: The unique ID of the criteria. + example: 5ec18cef39020d6fd7a60ad3970aba61 + nullable: true + suppressMatchedItems: + type: boolean + description: | + If this value is true, then matched items will not only be excluded from the campaign, they will also not have archived certification items created. + Such items will not appear in the exclusion report. + example: false + default: false + children: + type: array + description: List of child criteria. + items: + type: object + required: + - type + - property + - value + example: [ + { + "type": "IDENTITY_ATTRIBUTE", + "property": "displayName", + "value": "support", + "operation": "CONTAINS", + "negateResult": false, + "shortCircuit": false, + "recordChildMatches": false, + "id": null, + "suppressMatchedItems": false, + "children": null + } + ] + isSystemFilter: + type: boolean + default: false + description: If true, the filter is created by the system. If false, the filter is created by a user. + example: false +required: + - id + - name + - owner + - mode + - isSystemFilter \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/CampaignReference.yaml b/static/api-specs/idn/v2025/schemas/CampaignReference.yaml new file mode 100644 index 000000000..faf31e6df --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/CampaignReference.yaml @@ -0,0 +1,56 @@ +type: object +required: +- id +- name +- type +- campaignType +- description +- correlatedStatus +- mandatoryCommentRequirement +properties: + id: + type: string + description: The unique ID of the campaign. + example: ef38f94347e94562b5bb8424a56397d8 + name: + type: string + description: The name of the campaign. + example: 'Campaign Name' + type: + type: string + enum: + - CAMPAIGN + description: The type of object that is being referenced. + example: CAMPAIGN + campaignType: + type: string + enum: + - MANAGER + - SOURCE_OWNER + - SEARCH + description: The type of the campaign. + example: MANAGER + description: + type: string + description: The description of the campaign set by the admin who created it. + nullable: true + example: 'A description of the campaign' + correlatedStatus: + type: string + description: >- + The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. + An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). + enum: + - "CORRELATED" + - "UNCORRELATED" + example: CORRELATED + mandatoryCommentRequirement: + type: string + description: >- + Determines whether comments are required for decisions during certification reviews. You can require comments + for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. + enum: + - "ALL_DECISIONS" + - "REVOKE_ONLY_DECISIONS" + - "NO_DECISIONS" + example: NO_DECISIONS \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/CampaignReport.yaml b/static/api-specs/idn/v2025/schemas/CampaignReport.yaml new file mode 100644 index 000000000..3b5860080 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/CampaignReport.yaml @@ -0,0 +1,22 @@ +type : object +title: Campaign Report +required: + - reportType +allOf: +- $ref: './ReportResultReference.yaml' +- type: object + properties: + reportType: + $ref: './ReportType.yaml' + lastRunAt: + type: string + readOnly: true + format: date-time + description: The most recent date and time this report was run +example: + type: REPORT_RESULT + id: 2c91808568c529c60168cca6f90c1313 + name: Campaign Composition Report + status: SUCCESS + reportType: CAMPAIGN_COMPOSITION_REPORT + lastRunAt: '2019-12-19T13:49:37.385Z' diff --git a/static/api-specs/idn/v2025/schemas/CampaignReportsConfig.yaml b/static/api-specs/idn/v2025/schemas/CampaignReportsConfig.yaml new file mode 100644 index 000000000..a367aec62 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/CampaignReportsConfig.yaml @@ -0,0 +1,12 @@ +type : object +title: Campaign Reports Configuration +properties: + identityAttributeColumns: + type: array + nullable: true + description: list of identity attribute columns + items: + type: string + example: + - firstname + - lastname diff --git a/static/api-specs/idn/v2025/schemas/CampaignTemplate.yaml b/static/api-specs/idn/v2025/schemas/CampaignTemplate.yaml new file mode 100644 index 000000000..1e42b0ec6 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/CampaignTemplate.yaml @@ -0,0 +1,76 @@ +type: object +description: Campaign Template +properties: + id: + type: string + description: Id of the campaign template + example: 2c9079b270a266a60170a277bb960008 + name: + type: string + description: This template's name. Has no bearing on generated campaigns' names. + example: Manager Campaign Template + description: + type: string + description: This template's description. Has no bearing on generated campaigns' descriptions. + example: Template for the annual manager campaign. + created: + type: string + description: Creation date of Campaign Template + readOnly: true + format: date-time + example: '2020-03-05T22:44:00.364Z' + modified: + type: string + nullable: true + description: Modification date of Campaign Template + readOnly: true + format: date-time + example: '2020-03-05T22:52:09.969Z' + scheduled: + type: boolean + readOnly: true + description: Indicates if this campaign template has been scheduled. + example: false + default: false + ownerRef: + type : object + readOnly: true + description: >- + The owner of this template, and the owner of campaigns generated from this template via a schedule. This field + is automatically populated at creation time with the current user. + properties: + id: + type: string + description: Id of the owner + example: 2c918086676d3e0601677611dbde220f + type: + type: string + enum: + - IDENTITY + description: Type of the owner + example: IDENTITY + name: + type: string + description: Name of the owner + example: Mister Manager + email: + type: string + description: Email of the owner + example: mr.manager@example.com + deadlineDuration: + type: string + nullable: true + description: >- + The time period during which the campaign should be completed, formatted as an ISO-8601 Duration. When this template + generates a campaign, the campaign's deadline will be the current date plus this duration. For example, if generation + occurred on 2020-01-01 and this field was "P2W" (two weeks), the resulting campaign's deadline would be 2020-01-15 + (the current date plus 14 days). + example: P2W + campaign: + $ref: './Campaign.yaml' +required: + - name + - description + - created + - modified + - campaign \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/CampaignsDeleteRequest.yaml b/static/api-specs/idn/v2025/schemas/CampaignsDeleteRequest.yaml new file mode 100644 index 000000000..2df36fffb --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/CampaignsDeleteRequest.yaml @@ -0,0 +1,9 @@ +type : object +properties: + ids: + description: The ids of the campaigns to delete + type: array + items: + type: string + example: + ["2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021"] \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/CancelAccessRequest.yaml b/static/api-specs/idn/v2025/schemas/CancelAccessRequest.yaml new file mode 100644 index 000000000..83e0633e1 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/CancelAccessRequest.yaml @@ -0,0 +1,14 @@ +type : object +description: Request body payload for cancel access request endpoint. +required: + - accountActivityId + - comment +properties: + accountActivityId: + type: string + description: This refers to the identityRequestId. To successfully cancel an access request, you must provide the identityRequestId. + example: 2c9180835d2e5168015d32f890ca1581 + comment: + type: string + description: Reason for cancelling the pending access request. + example: "I requested this role by mistake." diff --git a/static/api-specs/idn/v2025/schemas/CancelableAccountActivity.yaml b/static/api-specs/idn/v2025/schemas/CancelableAccountActivity.yaml new file mode 100644 index 000000000..f4b3c1947 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/CancelableAccountActivity.yaml @@ -0,0 +1,67 @@ +type : object +properties: + id: + type: string + description: ID of the account activity itself + example: 2c9180835d2e5168015d32f890ca1581 + name: + type: string + example: 2c9180835d2e5168015d32f890ca1581 + created: + type: string + format: 'date-time' + example: '2017-07-11T18:45:37.098Z' + modified: + type: string + nullable: true + format: 'date-time' + example: '2018-06-25T20:22:28.104Z' + completed: + type: string + nullable: true + format: 'date-time' + example: '2018-10-19T13:49:37.385Z' + completionStatus: + $ref: './CompletionStatus.yaml' + type: + type: string + nullable: true + example: appRequest + requesterIdentitySummary: + $ref: './IdentitySummary.yaml' + targetIdentitySummary: + $ref: './IdentitySummary.yaml' + errors: + type: array + nullable: true + items: + type: string + example: ["sailpoint.connector.ConnectorException: java.lang.InterruptedException: Timeout waiting for response to message 0 from client 57a4ab97-ab3f-4aef-9fe2-0eaf15c73d26 after 60 seconds."] + warnings: + type: array + nullable: true + items: + type: string + example: null + items: + type: array + nullable: true + items: + $ref: './AccountActivityItem.yaml' + executionStatus: + $ref: './ExecutionStatus.yaml' + clientMetadata: + type: object + nullable: true + additionalProperties: + type: string + description: >- + Arbitrary key-value pairs, if any were included in the corresponding access request + cancelable: + type: boolean + description: Whether the account activity can be canceled before completion + cancelComment: + $ref: './Comment.yaml' + + + diff --git a/static/api-specs/idn/v2025/schemas/CancelledRequestDetails.yaml b/static/api-specs/idn/v2025/schemas/CancelledRequestDetails.yaml new file mode 100644 index 000000000..41fadec1a --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/CancelledRequestDetails.yaml @@ -0,0 +1,14 @@ +type: object +properties: + comment: + type: string + description: Comment made by the owner when cancelling the associated request. + example: This request must be cancelled. + owner: + $ref: './OwnerDto.yaml' + modified: + type: string + format: date-time + description: Date comment was added by the owner when cancelling the associated request. + example: '2019-12-20T09:17:12.192Z' +description: Provides additional details for a request that has been cancelled. \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/CertificateSignInput.yaml b/static/api-specs/idn/v2025/schemas/CertificateSignInput.yaml new file mode 100644 index 000000000..e83863e39 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/CertificateSignInput.yaml @@ -0,0 +1,8 @@ +description: Sign Certificate Request +type: object +properties: + certificateSigningRequest: + description: The certificate signing request (CSR) + readOnly: true + type: string + example: -----BEGIN CERTIFICATE REQUEST-----******-----END CERTIFICATE REQUEST----- diff --git a/static/api-specs/idn/v2025/schemas/CertificateSignResponse.yaml b/static/api-specs/idn/v2025/schemas/CertificateSignResponse.yaml new file mode 100644 index 000000000..e7368b8ca --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/CertificateSignResponse.yaml @@ -0,0 +1,13 @@ +description: Sign Certificate Response +type: object +properties: + certificate: + description: Certificate + readOnly: true + type: string + example: -----BEGIN CERTIFICATE-----******-----END CERTIFICATE----- + certificateChain: + description: Certificate chain + readOnly: true + type: string + example: -----BEGIN CERTIFICATE CHAIN-----******-----END CERTIFICATE CHAIN----- diff --git a/static/api-specs/idn/v2025/schemas/CertificationDecision.yaml b/static/api-specs/idn/v2025/schemas/CertificationDecision.yaml new file mode 100644 index 000000000..01db2c1fb --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/CertificationDecision.yaml @@ -0,0 +1,6 @@ +type: string +description: The decision to approve or revoke the review item +enum: + - APPROVE + - REVOKE +example: APPROVE diff --git a/static/api-specs/idn/v2025/schemas/CertificationDto.yaml b/static/api-specs/idn/v2025/schemas/CertificationDto.yaml new file mode 100644 index 000000000..4d3eaf9b9 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/CertificationDto.yaml @@ -0,0 +1,70 @@ +# Replaces IdentityCertificationDto.yaml +type: object +required: +- campaignRef +- completed +- decisionsMade +- decisionsTotal +- due +- signed +- reviewer +- campaignOwner +- hasErrors +- phase +- entitiesCompleted +- entitiesTotal +properties: + campaignRef: + $ref: './CampaignReference.yaml' + phase: + $ref: './CertificationPhase.yaml' + due: + type: string + format: 'date-time' + description: The due date of the certification. + example: '2018-10-19T13:49:37.385Z' + signed: + type: string + format: 'date-time' + description: The date the reviewer signed off on the certification. + example: '2018-10-19T13:49:37.385Z' + reviewer: + $ref: './Reviewer.yaml' + description: A reference to the reviewer of the campaign. + reassignment: + $ref: './Reassignment.yaml' + nullable: true + description: A reference to a reviewer that this campaign has been reassigned to. + hasErrors: + type: boolean + example: false + description: Indicates it the certification has any errors. + errorMessage: + type: string + nullable: true + example: The certification has an error + description: A message indicating what the error is. + completed: + type: boolean + description: Indicates if all certification decisions have been made. + example: false + decisionsMade: + type: integer + description: The number of approve/revoke/acknowledge decisions that have been made by the reviewer. + example: 20 + format: int32 + decisionsTotal: + type: integer + description: The total number of approve/revoke/acknowledge decisions for the certification. + example: 40 + format: int32 + entitiesCompleted: + type: integer + description: The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete. + example: 5 + format: int32 + entitiesTotal: + type: integer + format: int32 + description: The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. + example: 10 diff --git a/static/api-specs/idn/v2025/schemas/CertificationIdentitySummary.yaml b/static/api-specs/idn/v2025/schemas/CertificationIdentitySummary.yaml new file mode 100644 index 000000000..3bdd3dc68 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/CertificationIdentitySummary.yaml @@ -0,0 +1,20 @@ +type: object +properties: + id: + type: string + description: The ID of the identity summary + example: 2c91808772a504f50172a9540e501ba7 + name: + type: string + description: Name of the linked identity + example: Alison Ferguso + identityId: + type: string + description: The ID of the identity being certified + example: 2c9180857182306001719937377a33de + completed: + type: boolean + description: + Indicates whether the review items for the linked identity's certification + have been completed + example: true diff --git a/static/api-specs/idn/v2025/schemas/CertificationItemType.yaml b/static/api-specs/idn/v2025/schemas/CertificationItemType.yaml new file mode 100644 index 000000000..dc5e072e4 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/CertificationItemType.yaml @@ -0,0 +1,11 @@ +type: string +enum: + - ENTITLEMENT + - ACCESS_PROFILE + - ROLE + - ROLE_NAME + - ROLE_DESCRIPTION + - ROLE_CRITERIA + - ROLE_CRITERIA_RULE + - ROLE_CRITERIA_MEMBER +example: ROLE diff --git a/static/api-specs/idn/v2025/schemas/CertificationPhase.yaml b/static/api-specs/idn/v2025/schemas/CertificationPhase.yaml new file mode 100644 index 000000000..3f3cfdeea --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/CertificationPhase.yaml @@ -0,0 +1,11 @@ +type: string +description: | + The current phase of the campaign. + * `STAGED`: The campaign is waiting to be activated. + * `ACTIVE`: The campaign is active. + * `SIGNED`: The reviewer has signed off on the campaign, and it is considered complete. +enum: + - STAGED + - ACTIVE + - SIGNED +example: ACTIVE diff --git a/static/api-specs/idn/v2025/schemas/CertificationReference.yaml b/static/api-specs/idn/v2025/schemas/CertificationReference.yaml new file mode 100644 index 000000000..e1e2561f3 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/CertificationReference.yaml @@ -0,0 +1,17 @@ +type: object +properties: + id: + type: string + description: The id of the certification. + example: ef38f94347e94562b5bb8424a56397d8 + name: + type: string + description: The name of the certification. + example: "Certification Name" + type: + type: string + enum: + - CERTIFICATION + example: CERTIFICATION + reviewer: + $ref: "./Reviewer.yaml" diff --git a/static/api-specs/idn/v2025/schemas/CertificationReferenceDto.yaml b/static/api-specs/idn/v2025/schemas/CertificationReferenceDto.yaml new file mode 100644 index 000000000..87545a143 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/CertificationReferenceDto.yaml @@ -0,0 +1,17 @@ +type: object +description: Certification for review. +properties: + type: + type: string + description: DTO type of certification for review. + enum: + - CERTIFICATION + example: IDENTITY + id: + type: string + description: ID of certification for review. + example: 7589a83cec4b4f138ce56c1a5ef0756d + name: + type: string + description: Display name of certification for review. + example: Manager Access for Michael Michaels diff --git a/static/api-specs/idn/v2025/schemas/CertificationResponse.yaml b/static/api-specs/idn/v2025/schemas/CertificationResponse.yaml new file mode 100644 index 000000000..19c3c3cb1 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/CertificationResponse.yaml @@ -0,0 +1,23 @@ +type: object +properties: + id: + type: string + description: the id of the certification + name: + type: string + description: the certification name + signedDate: + type: string + description: the date ceritification was signed + certifiers: + type: array + items: + $ref: './IdentitySummaryResponse.yaml' +example: + id: 2c91808a77ff216301782327a50f09bf + name: Cert name + signedDate: '2019-03-08T22:37:33.901Z' + certifiers: + - id: 8a80828f643d484f01643e14202e206f + name: Certifier Name + displayName: John Snow \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/CertificationTask.yaml b/static/api-specs/idn/v2025/schemas/CertificationTask.yaml new file mode 100644 index 000000000..e111c620a --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/CertificationTask.yaml @@ -0,0 +1,50 @@ +type: object +properties: + id: + type: string + description: The ID of the certification task. + example: 2c918086719eec070171a7e3355a360a + type: + type: string + description: The type of the certification task. More values may be added in the future. + enum: + - REASSIGN + - ADMIN_REASSIGN + - COMPLETE_CERTIFICATION + - FINISH_CERTIFICATION + - COMPLETE_CAMPAIGN + - ACTIVATE_CAMPAIGN + - CAMPAIGN_CREATE + - CAMPAIGN_DELETE + example: ADMIN_REASSIGN + targetType: + type: string + description: The type of item that is being operated on by this task whose ID is stored in the targetId field. + enum: + - CERTIFICATION + - CAMPAIGN + example: CAMPAIGN + targetId: + type: string + description: The ID of the item being operated on by this task. + example: 2c918086719eec070171a7e3355a834c + status: + type: string + description: The status of the task. + enum: + - QUEUED + - IN_PROGRESS + - SUCCESS + - ERROR + example: QUEUED + errors: + $ref: './ErrorMessageDtoList.yaml' + description: A list of errors that have been encountered by the task. + reassignmentTrailDTOs: + $ref: './ReassignmentTrailDTOList.yaml' + description: Reassignment trails that lead to self certification identity + created: + type: string + description: The date and time on which this task was created. + format: date-time + example: '2020-09-24T18:10:47.693Z' diff --git a/static/api-specs/idn/v2025/schemas/CertifierResponse.yaml b/static/api-specs/idn/v2025/schemas/CertifierResponse.yaml new file mode 100644 index 000000000..a0671e563 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/CertifierResponse.yaml @@ -0,0 +1,11 @@ +type: object +properties: + id: + type: string + description: the id of the certifier + example: 8a80828f643d484f01643e14202e206f + displayName: + type: string + description: the name of the certifier + example: John Snow + \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/Change.yaml b/static/api-specs/idn/v2025/schemas/Change.yaml new file mode 100644 index 000000000..8a8b0a664 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/Change.yaml @@ -0,0 +1,18 @@ +type: object +properties: + op: + type: string + description: operation + example: '2021-01-30T08:30:00Z' + from: + type: string + description: from date + example: '2021-01-30T08:30:00Z' + path: + type: string + description: path to changed property + example: '/attributes/attributes' + value: + type: string + description: changed value + example: '{\"approvalSchemes\":\"none\",\"cloudSelectorType\":\"IDENTITY_LIST\",\"deniedCommentsRequired\":false,\"requestCommentsRequired\":false,\"requestable\":true,\"revokeRequestApprovalSchemes\":\"none\",\"sysDescriptions\":{\"en_US\":\"matches sages Role-abfd98. \\nThis is a test of the newline character in the description. \\nHow about some foreign characters too? \\nTest du français \\nТестування української \\nதமிழை சோதிக்கிறது\"}}' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/ChangeRequest.yaml b/static/api-specs/idn/v2025/schemas/ChangeRequest.yaml new file mode 100644 index 000000000..1cf48a2e7 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ChangeRequest.yaml @@ -0,0 +1,14 @@ +description: Details of a change request Service Desk integration +required: + - provision + - checkStatus +type: object +properties: + provision: + description: provisioning details for the change request Service Desk integration + type: object + $ref: './BasicProvision.yaml' + checkStatus: + description: check status mappings for the Service Desk integration + type: object + $ref: './CheckStatus.yaml' diff --git a/static/api-specs/idn/v2025/schemas/ChangesetDetails.yaml b/static/api-specs/idn/v2025/schemas/ChangesetDetails.yaml new file mode 100644 index 000000000..0ddbecf46 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ChangesetDetails.yaml @@ -0,0 +1,25 @@ +type: object +properties: + timestamp: + type: string + description: timestamp + example: '2021-01-30T08:30:00Z' + changes: + type: array + description: Change description + items: + $ref: '../../beta/schemas/Change.yaml' + example: '[ + { + "op": "replace", + "from": null, + "path": "/attributes/selectorSummary", + "value": "- \n
Geben Sie bei Zeit\\u00fcberschreitung bei Verbindung die maximal erlaubte Zeitdauer (in Minuten) f\\u00fcr die Verbindung von IdentityNow mit der Quelle ein.
Geben Sie die Host-URL der Delinea-SCIM-Serverquelle ein.
Geben Sie den API-Token der Quelle zur Authentifizierung ein.\nsectionInfo_AggregationSettings=Geben Sie die Einstellungen f\\u00fcr Ihre Aggregation an.
Geben Sie in das Feld Seitengr\\u00f6\\u00dfe die Anzahl an Kontoeintr\\u00e4gen ein, die auf einer einzelnen Seite aggregiert werden sollen, wenn gro\\u00dfe Datens\\u00e4tze durchlaufen werden.
\\n
Geben Sie im Kontofilter die Bedingungen f\\u00fcr den Kontofilter an. Beispiel: userName sw \"S\"
Geben Sie im Gruppenfilter die Gruppenfilterbedingungen an. Beispiel: displayName sw \"S\".\nplaceHolder_accAggregation=userName sw \"S\"\nplaceHolder_grpAggregation=displayName sw \"S\"\nplaceHolder_host=https://{Delinea_SCIM_Server_host}/v2\ndocLinkLabel_AuthenticationSettings=Mehr \\u00fcber Verbindungseinstellungen\ndocLinkLabel_Filters=Mehr \\u00fcber Konto- und Gruppenfilter\nHostURL=Host-URL\nConnectionTimeout=Zeit\\u00fcberschreitung bei Verbindung\nAPI_TOKEN=API-Token\nJSONPathMapping=JSON-Path-Attribut-Mapping\nFilterConditionForAccounts=Kontofilter\nFilterConditionForGroups=Gruppenfilter\nPage_Size=Seitengr\\u00f6\\u00dfe\nSchemaAttribute=Schema-Attribut\nJSONpath=JSON-Pfad\nShortDesc=Das Integrationsmodul IdentityNow f\\u00fcr Delinea Secret Server On-Premise bietet die M\\u00f6glichkeit einer tiefen Governance f\\u00fcr Konten und Gruppen. Es unterst\\u00fctzt au\\u00dferdem das End-to-End-Lebenszyklus-Management.", + } + connectorMetadata: + type: object + description: A map containing metadata pertinent to the UI to be used + additionalProperties: true + example: { + "supportedUI": "EXTJS", + "platform": "ccg", + "shortDesc": "connector description" + } + status: + type: string + enum: + - DEPRECATED + - DEVELOPMENT + - DEMO + - RELEASED + description: The connector status + example: "RELEASED" \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/ConnectorFileUploadHistory.yaml b/static/api-specs/idn/v2025/schemas/ConnectorFileUploadHistory.yaml new file mode 100644 index 000000000..a878b4e25 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ConnectorFileUploadHistory.yaml @@ -0,0 +1,11 @@ +description: Connector File Upload History +type: object +properties: + date: + description: The date of file being uploaded + type: string + example: '2022-06-02T10:00:20.670870Z' + file: + description: connector file name + type: string + example: temp7081703651350031905mysql-connector-java-8.0.11.jar diff --git a/static/api-specs/idn/v2025/schemas/ConnectorMessage.yaml b/static/api-specs/idn/v2025/schemas/ConnectorMessage.yaml new file mode 100644 index 000000000..0033a9a2b --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ConnectorMessage.yaml @@ -0,0 +1,12 @@ +type: object +properties: + application: + type: string + description: The source name for the message. + example: "Test Active Directory" + applicationId: + type: string + description: The source id for the message. + example: "2c928091638fccc601638fcf023d02ef" + globalCacheConfig: + $ref: './ConnectorCacheConfig.yaml' diff --git a/static/api-specs/idn/v2025/schemas/ConnectorRuleCreateRequest.yaml b/static/api-specs/idn/v2025/schemas/ConnectorRuleCreateRequest.yaml new file mode 100644 index 000000000..639c89f0a --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ConnectorRuleCreateRequest.yaml @@ -0,0 +1,68 @@ +description: ConnectorRuleCreateRequest +type: object +required: + - name + - type + - sourceCode +properties: + name: + type: string + description: the name of the rule + example: WebServiceBeforeOperationRule + minLength: 1 + maxLength: 128 + description: + type: string + nullable: true + description: a description of the rule's purpose + example: This rule does that + type: + type: string + enum: + - BuildMap + - ConnectorAfterCreate + - ConnectorAfterDelete + - ConnectorAfterModify + - ConnectorBeforeCreate + - ConnectorBeforeDelete + - ConnectorBeforeModify + - JDBCBuildMap + - JDBCOperationProvisioning + - JDBCProvision + - PeopleSoftHRMSBuildMap + - PeopleSoftHRMSOperationProvisioning + - PeopleSoftHRMSProvision + - RACFPermissionCustomization + - ResourceObjectCustomization + - SAPBuildMap + - SapHrManagerRule + - SapHrOperationProvisioning + - SapHrProvision + - SuccessFactorsOperationProvisioning + - WebServiceAfterOperationRule + - WebServiceBeforeOperationRule + - ResourceObjectCustomization + description: the type of rule + example: BuildMap + signature: + description: >- + The rule's function signature. + Describes the rule's input arguments and output (if any) + type: object + required: + - input + properties: + input: + type: array + items: + $ref: './Argument.yaml' + output: + $ref: './Argument.yaml' + sourceCode: + $ref: './SourceCode.yaml' + attributes: + type: object + nullable: true + description: a map of string to objects + example: {} + diff --git a/static/api-specs/idn/v2025/schemas/ConnectorRuleResponse.yaml b/static/api-specs/idn/v2025/schemas/ConnectorRuleResponse.yaml new file mode 100644 index 000000000..35b31e683 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ConnectorRuleResponse.yaml @@ -0,0 +1,22 @@ +description: ConnectorRuleResponse +allOf: + - $ref: './ConnectorRuleCreateRequest.yaml' + - type: object + nullable: true + required: + - id + - created + properties: + id: + type: string + description: the ID of the rule + example: '8113d48c0b914f17b4c6072d4dcb9dfe' + created: + type: string + description: an ISO 8601 UTC timestamp when this rule was created + example: '021-07-22T15:59:23Z' + modified: + type: string + nullable: true + description: an ISO 8601 UTC timestamp when this rule was last modified + example: '021-07-22T15:59:23Z' diff --git a/static/api-specs/idn/v2025/schemas/ConnectorRuleUpdateRequest.yaml b/static/api-specs/idn/v2025/schemas/ConnectorRuleUpdateRequest.yaml new file mode 100644 index 000000000..e879a4e00 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ConnectorRuleUpdateRequest.yaml @@ -0,0 +1,12 @@ +description: ConnectorRuleUpdateRequest +allOf: + - type: object + required: + - id + properties: + id: + type: string + description: the ID of the rule to update + example: 8113d48c0b914f17b4c6072d4dcb9dfe + - $ref: './ConnectorRuleCreateRequest.yaml' + diff --git a/static/api-specs/idn/v2025/schemas/ConnectorRuleValidationResponse.yaml b/static/api-specs/idn/v2025/schemas/ConnectorRuleValidationResponse.yaml new file mode 100644 index 000000000..fa7547541 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ConnectorRuleValidationResponse.yaml @@ -0,0 +1,34 @@ +description: ConnectorRuleValidationResponse +type: object +required: + - state + - details +properties: + state: + type: string + enum: + - OK + - ERROR + example: ERROR + details: + type: array + items: + description: CodeErrorDetail + type: object + required: + - line + - column + - message + properties: + line: + type: integer + description: The line number where the issue occurred + example: 2 + column: + type: integer + description: the column number where the issue occurred + example: 5 + messsage: + type: string + description: a description of the issue in the code + example: Remove reference to .decrypt( diff --git a/static/api-specs/idn/v2025/schemas/ConnectorSourcesUploadFiles.yaml b/static/api-specs/idn/v2025/schemas/ConnectorSourcesUploadFiles.yaml new file mode 100644 index 000000000..91caf1c2f --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ConnectorSourcesUploadFiles.yaml @@ -0,0 +1,19 @@ +description: Connector Sources Upload Files +type: object +properties: + id: + description: V3 Source Id + type: string + example: 2c918088776e36550177746ac4c71a44 + uploadHistory: + description: List of the connector upload history + type: array + items: + $ref: 'ConnectorFileUploadHistory.yaml' + example: + - file: "temp7081703651350031905mysql-connector-java-8.0.11.jar" + date: "2022-06-02T10:00:20.670870Z" + cloudExternalId: + description: CC Id, will be removed without notice when Migration to CEGS is finished + type: string + example: 540717 diff --git a/static/api-specs/idn/v2025/schemas/ContextAttributeDto.yaml b/static/api-specs/idn/v2025/schemas/ContextAttributeDto.yaml new file mode 100644 index 000000000..67aaf537a --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ContextAttributeDto.yaml @@ -0,0 +1,21 @@ +type: object +properties: + attribute: + type: string + description: The name of the attribute + example: "location" + value: + oneOf: + - type: string + example: "Austin" + - type: array + items: + type: string + example: [ "Austin", "Houston", "Dallas" ] + description: The value of the attribute. This can be either a string or a multi-valued string + example: "Austin" + derived: + type: boolean + description: True if the attribute was derived. + default: false + example: false diff --git a/static/api-specs/idn/v2025/schemas/CorrelatedGovernanceEvent.yaml b/static/api-specs/idn/v2025/schemas/CorrelatedGovernanceEvent.yaml new file mode 100644 index 000000000..384c7f0e1 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/CorrelatedGovernanceEvent.yaml @@ -0,0 +1,43 @@ +type: object +properties: + name: + type: string + description: The name of the governance event, such as the certification name or access request ID. + example: Manager Certification for Jon Snow + dt: + type: string + description: The date that the certification or access request was completed. + example: '2019-03-08T22:37:33.901Z' + type: + type: string + enum: + - certification + - accessRequest + description: The type of governance event. + example: certification + governanceId: + type: string + description: The ID of the instance that caused the event - either the certification ID or access request ID. + example: 2c91808a77ff216301782327a50f09bf + owners: + type: array + description: The owners of the governance event (the certifiers or approvers) + items: + $ref: './CertifierResponse.yaml' + example: + - id: 8a80828f643d484f01643e14202e206f + displayName: John Snow + reviewers: + type: array + description: The owners of the governance event (the certifiers or approvers), this field should be preferred over owners + items: + $ref: './CertifierResponse.yaml' + example: + - id: 8a80828f643d484f01643e14202e206f + displayName: John Snow + decisionMaker: + description: The decision maker + $ref: './CertifierResponse.yaml' + example: + id: 8a80828f643d484f01643e14202e206f + displayName: John Snow diff --git a/static/api-specs/idn/v2025/schemas/CorrelationConfig.yaml b/static/api-specs/idn/v2025/schemas/CorrelationConfig.yaml new file mode 100644 index 000000000..e5f9a31cf --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/CorrelationConfig.yaml @@ -0,0 +1,57 @@ +type: object +description: Source configuration information that is used by correlation process. +properties: + id: + type: string + nullable: true + description: The ID of the correlation configuration. + example: 2c9180835d191a86015d28455b4a2329 + name: + type: string + nullable: true + description: The name of the correlation configuration. + example: Source [source] Account Correlation + attributeAssignments: + type: array + nullable: true + description: The list of attribute assignments of the correlation configuration. + items: + type: object + description: The attribute assignment of the correlation configuration. + properties: + property: + type: string + description: The property of the attribute assignment. + example: first_name + value: + type: string + description: The value of the attribute assignment. + example: firstName + operation: + type: string + description: The operation of the attribute assignment. + enum: + - EQ + example: EQ + complex: + type: boolean + description: Whether or not the it's a complex attribute assignment. + default: false + example: false + ignoreCase: + type: boolean + description: Whether or not the attribute assignment should ignore case. + default: false + example: false + matchMode: + type: string + description: The match mode of the attribute assignment. + enum: + - ANYWHERE + - START + - END + example: ANYWHERE + filterString: + type: string + description: The filter string of the attribute assignment. + example: first_name == "John" diff --git a/static/api-specs/idn/v2025/schemas/CreateOAuthClientRequest.yaml b/static/api-specs/idn/v2025/schemas/CreateOAuthClientRequest.yaml new file mode 100644 index 000000000..05d127aa4 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/CreateOAuthClientRequest.yaml @@ -0,0 +1,99 @@ +type: object +properties: + businessName: + type: string + nullable: true + description: The name of the business the API Client should belong to + example: Acme-Solar + homepageUrl: + type: string + nullable: true + description: The homepage URL associated with the owner of the API Client + example: http://localhost:12345 + name: + type: string + nullable: true + description: A human-readable name for the API Client + example: Demo API Client + description: + type: string + nullable: true + description: A description of the API Client + example: + An API client used for the authorization_code, refresh_token, and + client_credentials flows + accessTokenValiditySeconds: + description: + The number of seconds an access token generated for this API Client is + valid for + type: integer + format: int32 + example: 750 + refreshTokenValiditySeconds: + description: + The number of seconds a refresh token generated for this API Client is + valid for + example: 86400 + type: integer + format: int32 + redirectUris: + type: array + nullable: true + items: + type: string + description: + A list of the approved redirect URIs. Provide one or more URIs when + assigning the AUTHORIZATION_CODE grant type to a new OAuth Client. + example: [ "http://localhost:12345" ] + grantTypes: + type: array + nullable: true + items: + $ref: "./GrantType.yaml" + description: + A list of OAuth 2.0 grant types this API Client can be used with + example: [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ] + accessType: + $ref: "./AccessType.yaml" + description: The access type (online or offline) of this API Client + example: "OFFLINE" + type: + $ref: "./ClientType.yaml" + description: The type of the API Client (public or confidential) + example: "CONFIDENTIAL" + internal: + type: boolean + description: + An indicator of whether the API Client can be used for requests internal + within the product. + example: false + enabled: + type: boolean + description: An indicator of whether the API Client is enabled for use + example: true + strongAuthSupported: + type: boolean + description: + An indicator of whether the API Client supports strong authentication + example: false + claimsSupported: + type: boolean + description: + An indicator of whether the API Client supports the serialization of SAML + claims when used with the authorization_code flow + example: false + scope: + type: array + nullable: true + items: + type: string + default: "sp:scopes:all" + description: Scopes of the API Client. If no scope is specified, the client will be created with the default scope "sp:scopes:all". This means the API Client will have all the rights of the owner who created it. + example: [ "demo:api-client-scope:first", "demo:api-client-scope:second" ] +required: + - name + - description + - accessTokenValiditySeconds + - grantTypes + - accessType + - enabled diff --git a/static/api-specs/idn/v2025/schemas/CreateOAuthClientResponse.yaml b/static/api-specs/idn/v2025/schemas/CreateOAuthClientResponse.yaml new file mode 100644 index 000000000..8fd761966 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/CreateOAuthClientResponse.yaml @@ -0,0 +1,129 @@ +type: object +properties: + id: + type: string + description: ID of the OAuth client + example: 2c9180835d2e5168015d32f890ca1581 + secret: + type: string + description: + Secret of the OAuth client (This field is only returned on the intial + create call.) + example: 5c32dd9b21adb51c77794d46e71de117a1d0ddb36a7ff941fa28014ab7de2cf3 + businessName: + type: string + description: The name of the business the API Client should belong to + example: Acme-Solar + homepageUrl: + type: string + description: The homepage URL associated with the owner of the API Client + example: http://localhost:12345 + name: + type: string + description: A human-readable name for the API Client + example: Demo API Client + description: + type: string + description: A description of the API Client + example: + An API client used for the authorization_code, refresh_token, and + client_credentials flows + accessTokenValiditySeconds: + description: + The number of seconds an access token generated for this API Client is + valid for + example: 750 + type: integer + format: int32 + refreshTokenValiditySeconds: + description: + The number of seconds a refresh token generated for this API Client is + valid for + example: 86400 + type: integer + format: int32 + redirectUris: + type: array + items: + type: string + description: + A list of the approved redirect URIs used with the authorization_code flow + example: [ "http://localhost:12345" ] + grantTypes: + type: array + items: + $ref: "./GrantType.yaml" + description: + A list of OAuth 2.0 grant types this API Client can be used with + example: [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ] + accessType: + $ref: "./AccessType.yaml" + description: The access type (online or offline) of this API Client + example: "OFFLINE" + type: + $ref: "./ClientType.yaml" + description: The type of the API Client (public or confidential) + example: "CONFIDENTIAL" + internal: + type: boolean + description: + An indicator of whether the API Client can be used for requests internal + to IDN + example: false + enabled: + type: boolean + description: An indicator of whether the API Client is enabled for use + example: true + strongAuthSupported: + type: boolean + description: + An indicator of whether the API Client supports strong authentication + example: false + claimsSupported: + type: boolean + description: + An indicator of whether the API Client supports the serialization of SAML + claims when used with the authorization_code flow + example: false + created: + type: string + format: "date-time" + description: + The date and time, down to the millisecond, when the API Client was + created + example: "2017-07-11T18:45:37.098Z" + modified: + type: string + format: "date-time" + description: + The date and time, down to the millisecond, when the API Client was last + updated + example: "2018-06-25T20:22:28.104Z" + scope: + type: array + nullable: true + items: + type: string + default: "sp:scopes:all" + description: Scopes of the API Client. + example: [ "demo:api-client-scope:first", "demo:api-client-scope:second" ] +required: + - id + - secret + - businessName + - homepageUrl + - name + - description + - accessTokenValiditySeconds + - refreshTokenValiditySeconds + - redirectUris + - grantTypes + - accessType + - type + - internal + - enabled + - strongAuthSupported + - claimsSupported + - created + - modified + - scope diff --git a/static/api-specs/idn/v2025/schemas/CreatePersonalAccessTokenRequest.yaml b/static/api-specs/idn/v2025/schemas/CreatePersonalAccessTokenRequest.yaml new file mode 100644 index 000000000..b534d9839 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/CreatePersonalAccessTokenRequest.yaml @@ -0,0 +1,29 @@ +type: object +description: Object for specifying the name of a personal access token to create +properties: + name: + type: string + description: >- + The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created. + example: "NodeJS Integration" + scope: + type: array + nullable: true + items: + type: string + default: "sp:scopes:all" + description: Scopes of the personal access token. If no scope is specified, the token will be created with the default scope "sp:scopes:all". This means the personal access token will have all the rights of the owner who created it. + example: [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ] + accessTokenValiditySeconds: + type: integer + format: int32 + minimum: 15 + maximum: 43200 + items: + type: integer + format: int32 + default: 43200 + description: Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. + example: 36900 +required: + - name diff --git a/static/api-specs/idn/v2025/schemas/CreatePersonalAccessTokenResponse.yaml b/static/api-specs/idn/v2025/schemas/CreatePersonalAccessTokenResponse.yaml new file mode 100644 index 000000000..03dc5207d --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/CreatePersonalAccessTokenResponse.yaml @@ -0,0 +1,46 @@ +type: object +properties: + id: + type: string + description: The ID of the personal access token (to be used as the username for Basic Auth). + example: "86f1dc6fe8f54414950454cbb11278fa" + secret: + type: string + description: The secret of the personal access token (to be used as the password for Basic Auth). + example: "1d1bef2b9f426383447f64f69349fc7cac176042578d205c256ba3f37c59adb9" + scope: + type: array + nullable: true + items: + type: string + default: "sp:scopes:all" + description: Scopes of the personal access token. + example: [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ] + name: + type: string + description: The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. + example: "NodeJS Integration" + owner: + $ref: './PatOwner.yaml' + created: + type: string + format: 'date-time' + description: The date and time, down to the millisecond, when this personal access token was created. + example: '2017-07-11T18:45:37.098Z' + accessTokenValiditySeconds: + type: integer + format: int32 + items: + type: integer + format: int32 + default: 43200 + description: Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. + example: 36900 +required: + - id + - secret + - scope + - name + - owner + - created + - accessTokenValiditySeconds diff --git a/static/api-specs/idn/v2025/schemas/CriteriaType.yaml b/static/api-specs/idn/v2025/schemas/CriteriaType.yaml new file mode 100644 index 000000000..a5fcfe112 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/CriteriaType.yaml @@ -0,0 +1,15 @@ +type: string +enum: + - COMPOSITE + - ROLE + - IDENTITY + - IDENTITY_ATTRIBUTE + - ENTITLEMENT + - ACCESS_PROFILE + - SOURCE + - ACCOUNT + - AGGREGATED_ENTITLEMENT + - INVALID_CERTIFIABLE_ENTITY + - INVALID_CERTIFIABLE_BUNDLE +description: Type of the criteria in the filter. The `COMPOSITE` filter can contain multiple filters in an AND/OR relationship. +example: IDENTITY_ATTRIBUTE diff --git a/static/api-specs/idn/v2025/schemas/CurrentWorkItemOwnerDto.yaml b/static/api-specs/idn/v2025/schemas/CurrentWorkItemOwnerDto.yaml new file mode 100644 index 000000000..2457eeb45 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/CurrentWorkItemOwnerDto.yaml @@ -0,0 +1,18 @@ +type: object +description: Identity of current work item owner. +properties: + type: + type: string + description: DTO type of current work item owner's identity. + enum: + - GOVERNANCE_GROUP + - IDENTITY + example: IDENTITY + id: + type: string + description: ID of current work item owner's identity. + example: 2c3780a46faadee4016fb4e018c20652 + name: + type: string + description: Display name of current work item owner. + example: Allen Albertson \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/CustomPasswordInstruction.yaml b/static/api-specs/idn/v2025/schemas/CustomPasswordInstruction.yaml new file mode 100644 index 000000000..a5ffb3457 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/CustomPasswordInstruction.yaml @@ -0,0 +1,31 @@ +type: object +properties: + pageId: + type: string + example: change-password:enter-password + description: The page ID that represents the page for forget user name, reset password and unlock account flow. + enum: + - change-password:enter-password + - change-password:finish + - flow-selection:select + - forget-username:user-email + - mfa:enter-code + - mfa:enter-kba + - mfa:select + - reset-password:enter-password + - reset-password:enter-username + - reset-password:finish + - unlock-account:enter-username + - unlock-account:finish + pageContent: + type: string + example: "Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter." + description: | + The custom instructions for the specified page. Allow basic HTML format and maximum length is 1000 characters. The custom instructions will be sanitized to avoid attacks. + If the customization text includes a link, like `...` clicking on this will open the link on the current browser page. + If you want your link to be redirected to a different page, please redirect it to "_blank" like this: `link`. This will open a new tab when the link is clicked. Notice we're only supporting _blank as the redirection target. + locale: + type: string + example: en + description: >- + The locale for the custom instructions, a BCP47 language tag. The default value is \"default\". diff --git a/static/api-specs/idn/v2025/schemas/DataAccess.yaml b/static/api-specs/idn/v2025/schemas/DataAccess.yaml new file mode 100644 index 000000000..d5517676b --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/DataAccess.yaml @@ -0,0 +1,36 @@ +type: object +description: DAS data for the entitlement +nullable: true +properties: + policies: + type: array + description: List of classification policies that apply to resources the entitlement \ groups has access to + items: + type: object + properties: + value: + type: string + description: Value of the policy + example: GDPR-20 + categories: + type: array + description: List of classification categories that apply to resources the entitlement \ groups has access to + items: + type: object + properties: + value: + type: string + description: Value of the category + example: email-7 + matchCount: + type: integer + description: Number of matched for each category + example: 10 + impactScore: + type: object + properties: + value: + type: string + description: Impact Score for this data + example: Medium + diff --git a/static/api-specs/idn/v2025/schemas/DataPipeline.yaml b/static/api-specs/idn/v2025/schemas/DataPipeline.yaml new file mode 100644 index 000000000..9ad67092f --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/DataPipeline.yaml @@ -0,0 +1,31 @@ +type: object +properties: + type: + type: string + enum: + - PGA + - STREAMING + description: The type of the data pipeline + example: STREAMING + dags: + type: array + description: List of airflow DAGs for a customer + items: + $ref: './AirflowDagDto.yaml' + example: + - id: airflow-dag-1 + runUrl: /admin/airflow/graph?dag_id=airflow-dag-1&execution_date=2020-06-02+15%3A05%3A03%2B00%3A00 + executionDate: '2020-06-02T15:05:03Z' + startDate: '2020-06-02T15:05:02Z' + lastUpdatedDate: '2020-07-02T15:05:02Z' + qualifiers: + - 20110909124646 + - 20119093434324 + - id: airflow-dag-2 + runUrl: /admin/airflow/graph?dag_id=airflow-dag-2&execution_date=2020-06-02+17%3A05%3A03%2B00%3A00 + executionDate: '2020-06-02T17:05:03Z' + startDate: '2020-06-02T17:05:02Z' + lastUpdatedDate: '2020-07-02T15:05:02Z' + qualifiers: + - 20110909124646 + - 20119093434324 diff --git a/static/api-specs/idn/v2025/schemas/DataPipelineEvent.yaml b/static/api-specs/idn/v2025/schemas/DataPipelineEvent.yaml new file mode 100644 index 000000000..6f0bfa921 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/DataPipelineEvent.yaml @@ -0,0 +1,40 @@ +type: object +properties: + timestamp: + type: string + format: 'date-time' + example: '2017-07-11T18:45:37.098Z' + type: + type: string + enum: + - IAI_PIPELINE_META + - IAI_PIPELINE_STREAMING + - IAI_PIPELINE_BATCH + - IAI_PIPELINE_ERROR + description: The type of the data pipeline event. + example: IAI_PIPELINE_STREAMING + dagId: + type: string + description: The Id of the Directed Acyclic Graph that produced the event. + example: ida-sp-one-streaming-144 + qualifier: + type: string + description: The specific run of this dag and its associated data. + example: 20110909123456 + operation: + type: string + description: The name of task/operation that produced this event + example: ProvisionFlinkCluster + status: + type: string + description: The outcome of the operation + enum: + - success + - failure + example: success + details: + type: object + additionalProperties: + type: string + description: >- + Arbitrary key-value pairs, related details of the event. diff --git a/static/api-specs/idn/v2025/schemas/DataPipelineOperation.yaml b/static/api-specs/idn/v2025/schemas/DataPipelineOperation.yaml new file mode 100644 index 000000000..e17c94cc4 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/DataPipelineOperation.yaml @@ -0,0 +1,20 @@ +type: object +properties: + timestamp: + type: string + format: 'date-time' + example: '2017-07-11T18:45:37.098Z' + operation: + type: string + description: The name of task/operation that produced this event + example: ProvisionFlinkCluster + status: + type: string + description: The outcome of the operation + enum: + - success + - failure + example: success + description: + type: string + description: description of the event and its outcome. diff --git a/static/api-specs/idn/v2025/schemas/DataPipelineQualifiers.yaml b/static/api-specs/idn/v2025/schemas/DataPipelineQualifiers.yaml new file mode 100644 index 000000000..d2c99dd96 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/DataPipelineQualifiers.yaml @@ -0,0 +1,24 @@ +type: object +properties: + qualifier: + type: string + description: The specific run of this DAG and its associated data. + example: 20110909123456 + dagId: + type: string + description: The Id of the Directed Acyclic Graph that produced the event. + example: ida-sp-one-streaming-144 + type: + type: string + enum: + - IAI_PIPELINE_META + - IAI_PIPELINE_STREAMING + - IAI_PIPELINE_BATCH + - IAI_PIPELINE_QUALIFIER_ACTIVATED + - IAI_PIPELINE_FEATURESTORE + - IAI_PIPELINE_IDENTITYGRAPH + - IAI_PIPELINE_MATERIALIZER + - IAI_PIPELINE_LOW_SIMILARITY_OUTLIERS + - IAI_PIPELINE_PEERGROUPS + description: The type of the data pipeline event. + example: IAI_PIPELINE_STREAMING \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/DataPipelineRelatedQualifiers.yaml b/static/api-specs/idn/v2025/schemas/DataPipelineRelatedQualifiers.yaml new file mode 100644 index 000000000..72f24660e --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/DataPipelineRelatedQualifiers.yaml @@ -0,0 +1,14 @@ +type: object +properties: + sourceQualifier: + type: string + description: The specific qualifier to search for. + example: 20110909123456 + derivedQualifiers: + type: array + description: The list of related qualifiers for the given qualifier + items: + type: string + example: + - 20110909124646 + - 2011909343432 \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/DataPipelineSummary.yaml b/static/api-specs/idn/v2025/schemas/DataPipelineSummary.yaml new file mode 100644 index 000000000..77eacd95f --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/DataPipelineSummary.yaml @@ -0,0 +1,56 @@ +type: object +properties: + created: + type: string + format: 'date-time' + example: '2021-02-25T18:45:37.098Z' + modified: + type: string + format: 'date-time' + example: '2021-03-26T18:25:34.098Z' + customerId: + type: string + description: Unique identifer of the customer + example: 534v0449-4yt0-4333-88y1-3bf1n2019c99 + qualifier: + type: string + description: The specific run of this DAG and its associated data. + example: 20110909123456 + dagId: + type: string + description: The Id of the Directed Acyclic Graph that produced the event. + example: ida-sp-one-streaming-144 + type: + type: string + enum: + - streaming + - batch + description: The type of the data pipeline. + example: streaming + hasError: + type: boolean + description: States whether or not an error has occured in the pipeline + operations: + type: array + description: Summary of events produced by the qualifier run of the DAG + items: + $ref: './DataPipelineOperation.yaml' + example: + - timestamp: "2020-09-09T12:34:56.000Z" + operation: ProvisionFlinkCluster + status: success + description: "" + - timestamp: "2020-09-09T12:34:00.013Z" + operation: ActivateQualifier + status: failure + description: "Qualifier data checks failed" + attributes: + type: object + additionalProperties: + type: string + description: >- + Arbitrary key-value pairs, related attributes to the DAG and qualifier run. + example: + build: '668-master' + resources.cluster_size: 's' + resources.flink.sink_parallelism: '2' diff --git a/static/api-specs/idn/v2025/schemas/DecisionSummary.yaml b/static/api-specs/idn/v2025/schemas/DecisionSummary.yaml new file mode 100644 index 000000000..86a78418b --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/DecisionSummary.yaml @@ -0,0 +1,17 @@ +# Replaces IdentityCertDecisionSummary.yaml +type: object +properties: + type: + $ref: './CertificationItemType.yaml' + approved: + description: Count of approval decisions for this item type. + type: integer + revoked: + description: Count of revoke decisions for this item type. + type: integer + decisionsMade: + description: Count of decisions made so far for this item type. + type: integer + decisionsTotal: + description: Count of all decisions for this item type, both made and yet-to-be-made. + type: integer diff --git a/static/api-specs/idn/v2025/schemas/DeleteCampaignsRequest.yaml b/static/api-specs/idn/v2025/schemas/DeleteCampaignsRequest.yaml new file mode 100644 index 000000000..2df36fffb --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/DeleteCampaignsRequest.yaml @@ -0,0 +1,9 @@ +type : object +properties: + ids: + description: The ids of the campaigns to delete + type: array + items: + type: string + example: + ["2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021"] \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/DependantAppConnections.yaml b/static/api-specs/idn/v2025/schemas/DependantAppConnections.yaml new file mode 100644 index 000000000..bd95e7fa5 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/DependantAppConnections.yaml @@ -0,0 +1,67 @@ +type: object +properties: + cloudAppId: + type: string + description: Id of the connected Application + example: 9e3cdd80edf84f119327df8bbd5bb5ac + description: + type: string + description: Description of the connected Application + example: This is a Sailpoint application + enabled: + type: boolean + description: Is the Application enabled + example: true + default: true + provisionRequestEnabled: + type: boolean + description: Is Provisioning enabled for connected Application + example: true + default: true + accountSource: + type: object + description: The Account Source of the connected Application + properties: + useForPasswordManagement: + type: boolean + description: Use this Account Source for password management + example: false + default: false + passwordPolicies: + type: array + description: A list of Password Policies for this Account Source + items: + type: object + properties: + type: + type: string + description: DTO type + example: PASSWORD_POLICY + id: + type: string + description: ID of the object to which this reference applies + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Human-readable display name of the object to which this reference applies + example: Policy ODS + launcherCount: + type: integer + format: int64 + description: The amount of launchers for connected Application (long type) + example: 100 + matchAllAccount: + type: boolean + description: Is Provisioning enabled for connected Application + example: true + default: false + owner: + type: array + description: The owner of the connected Application + items: + $ref: './BaseReferenceDto.yaml' + appCenterEnabled: + type: boolean + description: Is App Center enabled for connected Application + example: false + default: false diff --git a/static/api-specs/idn/v2025/schemas/DependantConnectionsMissingDto.yaml b/static/api-specs/idn/v2025/schemas/DependantConnectionsMissingDto.yaml new file mode 100644 index 000000000..0459c2738 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/DependantConnectionsMissingDto.yaml @@ -0,0 +1,17 @@ +type: object +properties: + dependencyType: + type: string + enum: + - identityProfiles + - credentialProfiles + - mappingProfiles + - sourceAttributes + - dependantCustomTransforms + - dependantApps + description: The type of dependency type that is missing in the SourceConnections + example: dependantApps + reason: + type: string + description: The reason why this dependency is missing + example: If there was an error retrieving any dependencies, it would lbe listed here diff --git a/static/api-specs/idn/v2025/schemas/DiscoveredApplications.yaml b/static/api-specs/idn/v2025/schemas/DiscoveredApplications.yaml new file mode 100644 index 000000000..fab14da10 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/DiscoveredApplications.yaml @@ -0,0 +1,45 @@ +type: array +description: An array of discovered applications for a given tenant +example: + - id: "app-123" + name: "ExampleApp" + discoverySource: "CSV" + discoveredVendor: "ExampleVendor" + description: "An application for managing examples." + recommendedConnectors: ["ConnectorA", "ConnectorB"] + discoveredTimestamp: "2023-01-01T12:00:00Z" +items: + type: object + properties: + id: + type: string + format: uuid + description: Unique identifier for the discovered application. + example: 2d9180835d2e5168015d32f890ca1581 + name: + type: string + description: Name of the discovered application. + example: "ExampleApp" + discoverySource: + type: string + description: Source from which the application was discovered. + example: "CSV" + discoveredVendor: + type: string + description: The vendor associated with the discovered application. + example: "ExampleVendor" + description: + type: string + description: A brief description of the discovered application. + example: "An application for managing examples." + recommendedConnectors: + type: array + items: + type: string + description: List of recommended connectors for the application. + example: ["ConnectorA", "ConnectorB"] + discoveredTimestamp: + type: string + format: date-time + description: The timestamp when the application was discovered, in ISO 8601 format. + example: "2023-01-01T12:00:00Z" \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/DkimAttributes.yaml b/static/api-specs/idn/v2025/schemas/DkimAttributes.yaml new file mode 100644 index 000000000..8fb937b40 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/DkimAttributes.yaml @@ -0,0 +1,26 @@ +type: object +properties: + id: + type: string + example: 123b45b0-aaaa-bbbb-a7db-123456a56abc + description: UUID associated with domain to be verified + address: + type: string + example: BobSmith@sailpoint.com + description: The identity or domain address + dkimEnabled: + type: boolean + default: false + example: true + description: Whether or not DKIM has been enabled for this domain / identity + dkimTokens: + type: array + items: + type: string + example: [ "uq1m3jjk25ckd3whl4n7y46c56r5l6aq","u7pm38jky9ckdawhlsn7y4dcj6f5lpgq","uhpm3jjkjjckdkwhlqn7yw6cjer5tpay" ] + description: The tokens to be added to a DNS for verification + dkimVerificationStatus: + type: string + example: Success + description: The current status if the domain /identity has been verified. Ie Success, Failed, Pending +description: DKIM attributes for a domain or identity \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/DomainAddress.yaml b/static/api-specs/idn/v2025/schemas/DomainAddress.yaml new file mode 100644 index 000000000..3c8bbcb2f --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/DomainAddress.yaml @@ -0,0 +1,6 @@ +type: object +properties: + domain: + type: string + example: sailpoint.com + description: A domain address \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/DomainStatusDto.yaml b/static/api-specs/idn/v2025/schemas/DomainStatusDto.yaml new file mode 100644 index 000000000..54819fc57 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/DomainStatusDto.yaml @@ -0,0 +1,25 @@ +type: object +properties: + id: + type: string + example: 123b45b0-aaaa-bbbb-a7db-123456a56abc + description: New UUID associated with domain to be verified + domain: + type: string + example: sailpoint.com + description: A domain address + dkimEnabled: + default: false + example: true + description: DKIM is enabled for this domain + dkimTokens: + type: array + items: + type: string + example: ["token1", "token2", "token3"] + description: DKIM tokens required for authentication + dkimVerificationStatus: + type: string + example: PENDING + description: Status of DKIM authentication +description: Domain status DTO containing everything required to verify via DKIM \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/DtoType.yaml b/static/api-specs/idn/v2025/schemas/DtoType.yaml new file mode 100644 index 000000000..4ccf35166 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/DtoType.yaml @@ -0,0 +1,33 @@ +type: string +enum: + - ACCOUNT_CORRELATION_CONFIG + - ACCESS_PROFILE + - ACCESS_REQUEST_APPROVAL + - ACCOUNT + - APPLICATION + - CAMPAIGN + - CAMPAIGN_FILTER + - CERTIFICATION + - CLUSTER + - CONNECTOR_SCHEMA + - ENTITLEMENT + - GOVERNANCE_GROUP + - IDENTITY + - IDENTITY_PROFILE + - IDENTITY_REQUEST + - MACHINE_IDENTITY + - LIFECYCLE_STATE + - PASSWORD_POLICY + - ROLE + - RULE + - SOD_POLICY + - SOURCE + - TAG + - TAG_CATEGORY + - TASK_RESULT + - REPORT_RESULT + - SOD_VIOLATION + - ACCOUNT_ACTIVITY + - WORKGROUP +description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. +example: IDENTITY diff --git a/static/api-specs/idn/v2025/schemas/DuoVerificationRequest.yaml b/static/api-specs/idn/v2025/schemas/DuoVerificationRequest.yaml new file mode 100644 index 000000000..0dbdef8f8 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/DuoVerificationRequest.yaml @@ -0,0 +1,15 @@ +type: object +properties: + userId: + type: string + nullable: false + description: User id for Verification request. + example: 2c9180947f0ef465017f215cbcfd004b + signedResponse: + type: string + nullable: false + description: User id for Verification request. + example: AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2 +required: + - userId + - signedResponse diff --git a/static/api-specs/idn/v2025/schemas/EmailNotificationOption.yaml b/static/api-specs/idn/v2025/schemas/EmailNotificationOption.yaml new file mode 100644 index 000000000..429fe9f1e --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/EmailNotificationOption.yaml @@ -0,0 +1,26 @@ +type : object +description: This is used for representing email configuration for a lifecycle state +properties: + notifyManagers: + type: boolean + default: false + example: true + description: If true, then the manager is notified of the lifecycle state change. + notifyAllAdmins: + type: boolean + default: false + example: true + description: If true, then all the admins are notified of the lifecycle state change. + notifySpecificUsers: + type: boolean + default: false + example: true + description: If true, then the users specified in "emailAddressList" below are notified of lifecycle state change. + emailAddressList: + type: array + example: ["test@test.com", "test2@test.com"] + items: + type: string + description: >- + List of user email addresses. If "notifySpecificUsers" option is true, then these users are notified of lifecycle state change. + diff --git a/static/api-specs/idn/v2025/schemas/EmailRequest.yaml b/static/api-specs/idn/v2025/schemas/EmailRequest.yaml new file mode 100644 index 000000000..52fb55a6b --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/EmailRequest.yaml @@ -0,0 +1,23 @@ +type: object +properties: + templateName: + type: string + description: The name of the email template to be rendered. + example: "Cloud Certification Activation" + recipientIds: + type: array + items: + type: string + description: The Identity ID's of the email recipients. + example: + - "2c928091638fccc601638fcf023d02ef" + - "2c928096641378d801641501bcce0044" + variables: + type: object + description: Variables to pass to the template engine. + example: + subject: "New access certification" + body: "A new access" + replyToAddr: "dummy@nowhere.com" + + diff --git a/static/api-specs/idn/v2025/schemas/EmailStatusDto.yaml b/static/api-specs/idn/v2025/schemas/EmailStatusDto.yaml new file mode 100644 index 000000000..ecad0fb70 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/EmailStatusDto.yaml @@ -0,0 +1,17 @@ +type: object +properties: + id: + type: string + nullable: true + email: + type: string + example: "sender@example.com" + isVerifiedByDomain: + type: boolean + example: false + verificationStatus: + type: string + enum: + - PENDING + - SUCCESS + - FAILED diff --git a/static/api-specs/idn/v2025/schemas/Entitlement.yaml b/static/api-specs/idn/v2025/schemas/Entitlement.yaml new file mode 100644 index 000000000..8c6437904 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/Entitlement.yaml @@ -0,0 +1,119 @@ +type: object +properties: + id: + type: string + description: The entitlement id + example: "2c91808874ff91550175097daaec161c" + name: + type: string + description: The entitlement name + example: "LauncherTest2" + attribute: + type: string + description: The entitlement attribute name + example: "memberOf" + value: + type: string + description: The value of the entitlement + example: "CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local" + sourceSchemaObjectType: + type: string + description: The object type of the entitlement from the source schema + example: "group" + description: + type: string + description: The description of the entitlement + example: "CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local" + nullable: true + privileged: + type: boolean + description: True if the entitlement is privileged + example: true + cloudGoverned: + type: boolean + description: True if the entitlement is cloud governed + example: true + requestable: + type: boolean + description: True if the entitlement is able to be directly requested + example: true + default: false + owner: + type: object + description: The identity that owns the entitlement + nullable: true + properties: + id: + type: string + description: The identity ID + example: 2c9180827ca885d7017ca8ce28a000eb + type: + type: string + enum: + - IDENTITY + description: The type of object + example: IDENTITY + name: + type: string + description: The display name of the identity + example: john.doe + manuallyUpdatedFields: + type: object + description: A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated. + nullable: true + additionalProperties: true + example: + DISPLAY_NAME: true + DESCRIPTION: true + accessModelMetadata: + type: object + description: Additional data to classify the entitlement + properties: + attributes: + type: array + items: + $ref: './AccessModelMetadata.yaml' + created: + type: string + description: Time when the entitlement was created + format: 'date-time' + example: "2020-10-08T18:33:52.029Z" + modified: + type: string + description: Time when the entitlement was last modified + format: 'date-time' + example: "2020-10-08T18:33:52.029Z" + source: + type: object + properties: + id: + type: string + description: The source ID + example: 2c9180827ca885d7017ca8ce28a000eb + type: + type: string + description: The source type, will always be "SOURCE" + example: SOURCE + name: + type: string + description: The source name + example: ODS-AD-Source + attributes: + type: object + description: A map of free-form key-value pairs from the source system + example: { "fieldName": "fieldValue"} + additionalProperties: true + segments: + type: array + items: + type: string + nullable: true + description: List of IDs of segments, if any, to which this Entitlement is assigned. + example: [ + "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", + "29cb6c06-1da8-43ea-8be4-b3125f248f2a" + ] + directPermissions: + type: array + items: + $ref: './PermissionDto.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/EntitlementAccessRequestConfig.yaml b/static/api-specs/idn/v2025/schemas/EntitlementAccessRequestConfig.yaml new file mode 100644 index 000000000..5ffa84d9b --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/EntitlementAccessRequestConfig.yaml @@ -0,0 +1,19 @@ +type: object +properties: + approvalSchemes: + type: array + description: Ordered list of approval steps for the access request. Empty when no approval is required. + items: + $ref: './EntitlementApprovalScheme.yaml' + requestCommentRequired: + type: boolean + description: If the requester must provide a comment during access request. + default: false + example: true + denialCommentRequired: + type: boolean + description: If the reviewer must provide a comment when denying the access request. + default: false + example: false + + diff --git a/static/api-specs/idn/v2025/schemas/EntitlementApprovalScheme.yaml b/static/api-specs/idn/v2025/schemas/EntitlementApprovalScheme.yaml new file mode 100644 index 000000000..e7b6ce9c1 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/EntitlementApprovalScheme.yaml @@ -0,0 +1,32 @@ +type: object +properties: + approverType: + type: string + enum: + - ENTITLEMENT_OWNER + - SOURCE_OWNER + - MANAGER + - GOVERNANCE_GROUP + description: >- + Describes the individual or group that is responsible for an approval step. Values are as follows. + + + **ENTITLEMENT_OWNER**: Owner of the associated Entitlement + + + **SOURCE_OWNER**: Owner of the associated Source + + + **MANAGER**: Manager of the Identity for whom the request is being made + + + **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field + + example: GOVERNANCE_GROUP + approverId: + type: string + nullable: true + description: Id of the specific approver, used only when approverType is GOVERNANCE_GROUP + example: e3eab852-8315-467f-9de7-70eda97f63c8 + + diff --git a/static/api-specs/idn/v2025/schemas/EntitlementBulkUpdateRequest.yaml b/static/api-specs/idn/v2025/schemas/EntitlementBulkUpdateRequest.yaml new file mode 100644 index 000000000..50a65148f --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/EntitlementBulkUpdateRequest.yaml @@ -0,0 +1,54 @@ +type: object +properties: + entitlementIds: + type: array + description: List of entitlement ids to update + maxItems: 50 + items: + type: string + example: + [ + "2c91808a7624751a01762f19d665220d", + "2c91808a7624751a01762f19d67c220e", + "2c91808a7624751a01762f19d692220f" + ] + jsonPatch: + type: array + items: + $ref: './JsonPatchOperation.yaml' + example: + [ + { + "op": "replace", + "path": "/privileged", + "value": false + }, + { + "op": "replace", + "path": "/requestable", + "value": false + } + ] +example: + { + "entitlementIds": [ + "2c91808a7624751a01762f19d665220d", + "2c91808a7624751a01762f19d67c220e", + "2c91808a7624751a01762f19d692220f" + ], + "jsonPatch": [ + { + "op": "replace", + "path": "/privileged", + "value": false + }, + { + "op": "replace", + "path": "/requestable", + "value": false + } + ] + } +required: + - entitlementIds + - jsonPatch \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/EntitlementDto.yaml b/static/api-specs/idn/v2025/schemas/EntitlementDto.yaml new file mode 100644 index 000000000..870a199cc --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/EntitlementDto.yaml @@ -0,0 +1,31 @@ +allOf: + - $ref: './BaseCommonDto.yaml' + - type: object + description: Entitlement object that represents entitlement + properties: + attribute: + description: Name of the entitlement attribute + type: string + example: authorizationType + value: + description: Raw value of the entitlement + type: string + example: CN=Users,dc=sailpoint,dc=com + description: + description: Entitlment description + type: string + attributes: + description: Entitlement attributes + type: object + sourceSchemaObjectType: + description: Schema objectType on the given application that maps to an Account Group + type: string + example: group + privileged: + description: Determines if this Entitlement is privileged. + type: boolean + cloudGoverned: + description: Determines if this Entitlement is goverened in the cloud. + type: boolean + source: + $ref: './EntitlementSource.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/EntitlementPopularityDto.yaml b/static/api-specs/idn/v2025/schemas/EntitlementPopularityDto.yaml new file mode 100644 index 000000000..ea412625b --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/EntitlementPopularityDto.yaml @@ -0,0 +1,9 @@ +type: object +properties: + attributeName: + type: string + description: the attribute name + example: "2c918085704000d90170456dae770028" + distribution: + type: object + $ref: './IdentityAttributeValueCountDto.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/EntitlementRef.yaml b/static/api-specs/idn/v2025/schemas/EntitlementRef.yaml new file mode 100644 index 000000000..53e2cc283 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/EntitlementRef.yaml @@ -0,0 +1,17 @@ +type: object +description: Entitlement including a specific set of access. +properties: + type: + type: string + description: Entitlement's DTO type. + enum: + - ENTITLEMENT + example: ENTITLEMENT + id: + type: string + description: Entitlement's ID. + example: 2c91809773dee32014e13e122092014e + name: + type: string + description: Entitlement's display name. + example: "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local" \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/EntitlementRefDto.yaml b/static/api-specs/idn/v2025/schemas/EntitlementRefDto.yaml new file mode 100644 index 000000000..1b00abbdb --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/EntitlementRefDto.yaml @@ -0,0 +1,15 @@ +type: object +properties: + id: + type: string + description: the entitlement ID + example: "2c918085704000d90170456dae770028" + name: + type: string + description: the entitlement name + example: "SBS Mobile Users" + description: + type: string + description: the entitlement description + example: "VPN access" + diff --git a/static/api-specs/idn/v2025/schemas/EntitlementRequestConfig.yaml b/static/api-specs/idn/v2025/schemas/EntitlementRequestConfig.yaml new file mode 100644 index 000000000..ab3e49eb0 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/EntitlementRequestConfig.yaml @@ -0,0 +1,27 @@ +type : object +properties: + allowEntitlementRequest: + type: boolean + description: If this is true, entitlement requests are allowed. + default: false + example: true + requestCommentsRequired: + type: boolean + description: If this is true, comments are required to submit entitlement requests. + default: false + example: false + deniedCommentsRequired: + type: boolean + description: If this is true, comments are required to reject entitlement requests. + default: false + example: false + grantRequestApprovalSchemes: + type: string + description: | + Approval schemes for granting entitlement request. This can be empty if no approval is needed. + Multiple schemes must be comma-separated. The valid schemes are "entitlementOwner", "sourceOwner", "manager" and "`workgroup:{id}`". + You can use multiple governance groups (workgroups). + default: sourceOwner + nullable: true + example: + "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/EntitlementSource.yaml b/static/api-specs/idn/v2025/schemas/EntitlementSource.yaml new file mode 100644 index 000000000..eba18f9ce --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/EntitlementSource.yaml @@ -0,0 +1,17 @@ +type: object +description: Source the entitlement belongs to. +properties: + type: + type: string + description: DTO type of source the entitlement belongs to. + enum: + - SOURCE + example: SOURCE + id: + type: string + description: ID of source the entitlement belongs to. + example: 2c9180835d191a86015d28455b4b232a + name: + type: string + description: Human-readable name of source the entitlement belongs to. + example: HR Active Directory diff --git a/static/api-specs/idn/v2025/schemas/EntitlementSourceResetBaseReferenceDto.yaml b/static/api-specs/idn/v2025/schemas/EntitlementSourceResetBaseReferenceDto.yaml new file mode 100644 index 000000000..bf7a46190 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/EntitlementSourceResetBaseReferenceDto.yaml @@ -0,0 +1,14 @@ +type: object +properties: + type: + type: string + description: The DTO type + example: TASK_RESULT + id: + type: string + description: The task ID of the object to which this reference applies + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Human-readable display name of the object to which this reference applies + example: Entitlement Source Reset \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/EntitlementViewResponse.yaml b/static/api-specs/idn/v2025/schemas/EntitlementViewResponse.yaml new file mode 100644 index 000000000..b092e3a50 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/EntitlementViewResponse.yaml @@ -0,0 +1,37 @@ +type: object +properties: + attribute: + type: string + description: the native identity + value: + type: string + description: the count of the entitlements + type: + type: number + description: the count of the permissions + description: + type: string + description: the description + accountName: + type: string + description: the name of account + displayName: + type: string + description: the name of item + firstObservedDate: + type: string + description: the date when we first see this piece in current identity + dataSourceName: + type: string + description: the data source name +example: + attribute: ent_code + value: group-20180328 + type: Entitlement + description: null + sourceName: JDBC Entitlements Source + accountName: null + displayName": group-20180328 + firstObservedDate: null + dataSourceName: null + \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/ErrorMessageDto.yaml b/static/api-specs/idn/v2025/schemas/ErrorMessageDto.yaml new file mode 100644 index 000000000..275fc7045 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ErrorMessageDto.yaml @@ -0,0 +1,15 @@ +type: object +properties: + locale: + type: string + description: The locale for the message text, a BCP 47 language tag. + example: en-US + nullable: true + localeOrigin: + $ref: "./LocaleOrigin.yaml" + text: + type: string + description: Actual text of the error message in the indicated locale. + example: + The request was syntactically correct but its content is semantically + invalid. diff --git a/static/api-specs/idn/v2025/schemas/ErrorMessageDtoList.yaml b/static/api-specs/idn/v2025/schemas/ErrorMessageDtoList.yaml new file mode 100644 index 000000000..e65f90fcb --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ErrorMessageDtoList.yaml @@ -0,0 +1,9 @@ +type: array +description: List of error messages +items: + $ref: './ErrorMessageDto.yaml' +example: { + "locale":"en-US", + "localeOrigin":"DEFAULT", + "text":"Error Message" +} diff --git a/static/api-specs/idn/v2025/schemas/ErrorResponseDto.yaml b/static/api-specs/idn/v2025/schemas/ErrorResponseDto.yaml new file mode 100644 index 000000000..7822bac12 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ErrorResponseDto.yaml @@ -0,0 +1,20 @@ +type : object +properties: + detailCode: + type: string + description: Fine-grained error code providing more detail of the error. + example: 400.1 Bad Request Content + trackingId: + type: string + description: Unique tracking id for the error. + example: e7eab60924f64aa284175b9fa3309599 + messages: + type: array + description: Generic localized reason for error + items: + $ref: "./ErrorMessageDto.yaml" + causes: + type: array + description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + items: + $ref: "./ErrorMessageDto.yaml" diff --git a/static/api-specs/idn/v2025/schemas/EventBridgeConfig.yaml b/static/api-specs/idn/v2025/schemas/EventBridgeConfig.yaml new file mode 100644 index 000000000..0e3ecfec5 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/EventBridgeConfig.yaml @@ -0,0 +1,14 @@ +type: object +properties: + awsAccount: + type: string + description: AWS Account Number (12-digit number) that has the EventBridge Partner Event Source Resource. + example: "123456789012" + awsRegion: + type: string + description: AWS Region that has the EventBridge Partner Event Source Resource. See https://docs.aws.amazon.com/general/latest/gr/rande.html for a full list of available values. + example: "us-west-1" + +required: + - awsAccount + - awsRegion diff --git a/static/api-specs/idn/v2025/schemas/EventStatus.yaml b/static/api-specs/idn/v2025/schemas/EventStatus.yaml new file mode 100644 index 000000000..0531a8693 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/EventStatus.yaml @@ -0,0 +1,8 @@ +type: object +properties: + count: + type: integer + description: Count of events of topic in the event table + topic: + type: string + description: Event topic name diff --git a/static/api-specs/idn/v2025/schemas/ExecutionStatus.yaml b/static/api-specs/idn/v2025/schemas/ExecutionStatus.yaml new file mode 100644 index 000000000..5ae9fb1f1 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ExecutionStatus.yaml @@ -0,0 +1,8 @@ +type: string +description: The current state of execution. +enum: + - EXECUTING + - VERIFYING + - TERMINATED + - COMPLETED +example: COMPLETED diff --git a/static/api-specs/idn/v2025/schemas/ExportOptions.yaml b/static/api-specs/idn/v2025/schemas/ExportOptions.yaml new file mode 100644 index 000000000..6adf1d4f4 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ExportOptions.yaml @@ -0,0 +1,77 @@ +type: object +properties: + excludeTypes: + description: Object type names to be excluded from an sp-config export command. + type: array + items: + type: string + enum: + - ACCESS_PROFILE + - ACCESS_REQUEST_CONFIG + - ATTR_SYNC_SOURCE_CONFIG + - AUTH_ORG + - CAMPAIGN_FILTER + - CONNECTOR_RULE + - FORM_DEFINITION + - GOVERNANCE_GROUP + - IDENTITY_OBJECT_CONFIG + - IDENTITY_PROFILE + - LIFECYCLE_STATE + - NOTIFICATION_TEMPLATE + - PASSWORD_POLICY + - PASSWORD_SYNC_GROUP + - PUBLIC_IDENTITIES_CONFIG + - ROLE + - RULE + - SEGMENT + - SERVICE_DESK_INTEGRATION + - SOD_POLICY + - SOURCE + - TAG + - TRANSFORM + - TRIGGER_SUBSCRIPTION + - WORKFLOW + example: "SOURCE" + includeTypes: + description: Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. + type: array + items: + type: string + enum: + - ACCESS_PROFILE + - ACCESS_REQUEST_CONFIG + - ATTR_SYNC_SOURCE_CONFIG + - AUTH_ORG + - CAMPAIGN_FILTER + - CONNECTOR_RULE + - FORM_DEFINITION + - GOVERNANCE_GROUP + - IDENTITY_OBJECT_CONFIG + - IDENTITY_PROFILE + - LIFECYCLE_STATE + - NOTIFICATION_TEMPLATE + - PASSWORD_POLICY + - PASSWORD_SYNC_GROUP + - PUBLIC_IDENTITIES_CONFIG + - ROLE + - RULE + - SEGMENT + - SERVICE_DESK_INTEGRATION + - SOD_POLICY + - SOURCE + - TAG + - TRANSFORM + - TRIGGER_SUBSCRIPTION + - WORKFLOW + example: "TRIGGER_SUBSCRIPTION" + objectOptions: + description: Additional options targeting specific objects related to each item in the includeTypes field + type: object + additionalProperties: + $ref: 'ObjectExportImportOptions.yaml' + example: { + "TRIGGER_SUBSCRIPTION": { + "includedIds": ["be9e116d-08e1-49fc-ab7f-fa585e96c9e4"], + "includedNames":["Test 2"] + } + } diff --git a/static/api-specs/idn/v2025/schemas/ExportPayload.yaml b/static/api-specs/idn/v2025/schemas/ExportPayload.yaml new file mode 100644 index 000000000..84092209d --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ExportPayload.yaml @@ -0,0 +1,8 @@ +type: object +allOf: + - $ref: "./ExportOptions.yaml" +properties: + description: + type: string + description: Optional user defined description/name for export job. + example: "Export Job 1 Test" diff --git a/static/api-specs/idn/v2025/schemas/Expression.yaml b/static/api-specs/idn/v2025/schemas/Expression.yaml new file mode 100644 index 000000000..334e7cce4 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/Expression.yaml @@ -0,0 +1,43 @@ +type: object +properties: + operator: + type: string + description: Operator for the expression + enum: + - AND + - EQUALS + example: "EQUALS" + attribute: + type: string + description: Name for the attribute + example: "location" + nullable: true + value: + $ref: './Value.yaml' + children: + type: array + nullable: true + description: List of expressions + items: + type: object + properties: + operator: + type: string + description: Operator for the expression + enum: + - AND + - EQUALS + example: "EQUALS" + attribute: + type: string + description: Name for the attribute + example: "location" + nullable: true + value: + $ref: './Value.yaml' + children: + type: string + nullable: true + description: There cannot be anymore nested children. This will always be null. + example: null + example: [] diff --git a/static/api-specs/idn/v2025/schemas/ExternalObjectDetails.yaml b/static/api-specs/idn/v2025/schemas/ExternalObjectDetails.yaml new file mode 100644 index 000000000..15b640a2e --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ExternalObjectDetails.yaml @@ -0,0 +1,54 @@ +type: object +description: Representation of an ingested object. This differs from the internal representation in that we denormalize some of the reference data for UI consumption. +properties: + id: + type: string + description: id + example: '24bdaf69-e5ce-4c08-96c4-2b93bce82088' + name: + type: string + description: Objects name + example: 'Ocie.48ad9323dbff4' + type: + type: string + description: Type of object + example: 'identity' + meta: + type: object + description: Object metadata + example: {"created" : "2021-09-29T14:16:23.995Z"} + attributes: + type: object + description: Object attributes + example: {"lastname" : "48ad9323dbff4"} + refs: + type: array + description: References to instance(s) of another name of object + items: + $ref: '../../beta/schemas/ExternalObjectDetailsReference.yaml' + example: '[ + { + "type": "identity", + "targets": [ + { + "id": "2c91808b6e61caab016e6b8ef796084b", + "name": "support" + } + ], + "label": "owner" + }, + { + "type": "accessProfile", + "targets": [ + { + "id": "2c91808674927fc6017493f12c3c04ee", + "name": "RoleMining-AccessProfile-One" + } + ], + "label": "accessProfiles" + } + ]' + integrationId: + type: string + description: integrationId + example: '24bdaf69-e5ce-4c08-96c4-2b93bce82088' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/ExternalObjectDetailsReference.yaml b/static/api-specs/idn/v2025/schemas/ExternalObjectDetailsReference.yaml new file mode 100644 index 000000000..0255e46fb --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ExternalObjectDetailsReference.yaml @@ -0,0 +1,26 @@ +type: object +description: Describes a reference to instance(s) of another name of object. +properties: + type: + type: string + description: id + example: '24bdaf69-e5ce-4c08-96c4-2b93bce82088' + name: + type: string + description: Object`s reference name + example: 'role' + targets: + type: array + description: A given target of a reference. + items: + $ref: '../../beta/schemas/ExternalObjectDetailsReferenceTarget.yaml' + example: '[ + { + "id": "2c91808b6e61caab016e6b8ef796084b", + "name": "support" + } + ]' + label: + type: string + description: Object`s reference label + example: 'roles' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/ExternalObjectDetailsReferenceTarget.yaml b/static/api-specs/idn/v2025/schemas/ExternalObjectDetailsReferenceTarget.yaml new file mode 100644 index 000000000..615a1c820 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ExternalObjectDetailsReferenceTarget.yaml @@ -0,0 +1,11 @@ +type: object +description: Represents the summary of an object, used in list APIs. This doesn't include attributes of references. +properties: + id: + type: string + description: id + example: '2c91808c7c30341d017c31ec2d9d0182' + name: + type: string + description: Object`s reference target name + example: 'Sales Role' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/ExternalObjectSummary.yaml b/static/api-specs/idn/v2025/schemas/ExternalObjectSummary.yaml new file mode 100644 index 000000000..efefa9b1b --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ExternalObjectSummary.yaml @@ -0,0 +1,23 @@ +type: object +description: Represents the summary of an object, used in list APIs. This doesn't include attributes of references. +properties: + id: + type: string + description: the id pf the external object summary + example: '24bdaf69-e5ce-4c08-96c4-2b93bce82088' + name: + type: string + description: Objects name + example: 'Ocie.48ad9323dbff4' + type: + type: string + description: Type of object + example: 'identity' + meta: + type: object + description: Object metadata + example: {"created" : "2021-09-29T14:16:23.995Z"} + integrationId: + type: string + description: integrationId + example: '24bdaf69-e5ce-4c08-96c4-2b93bce82088' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/ExtractRequest.yaml b/static/api-specs/idn/v2025/schemas/ExtractRequest.yaml new file mode 100644 index 000000000..35ef7f9fd --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/ExtractRequest.yaml @@ -0,0 +1,34 @@ +type: object +title: Extract Request +description: Request model for initiate extract from source connectors. +properties: + referenceId: + type: string + nullable: false + description: Reference ID at request initiator for tracking + format: uuid + example: 2c9180837ab5b716017ab7c6c9ef1e20 + fromUtc: + type: string + nullable: true + format: date-time + description: The start date/time for the extraction. ISO-8601 in UTC. + example: "2022-02-07T20:13:29.356648026Z" + toUtc: + type: string + nullable: true + format: date-time + description: The end date/time for the extraction. ISO-8601 in UTC. + example: "2022-02-07T20:13:29.356648026Z" + callbackUrl: + type: string + nullable: false + description: callback url for updates and completion. + example: https://your-callback-url + attributes: + type: object + nullable: true + additionalProperties: + type: string + description: map with attributes for an extract type + example: { "filters": ["USERID in (1015643,0)","TECH_STACK='AUDIT'"]} diff --git a/static/api-specs/idn/v2025/schemas/FeatureStoreFeatureValuesRequest.yaml b/static/api-specs/idn/v2025/schemas/FeatureStoreFeatureValuesRequest.yaml new file mode 100644 index 000000000..3439a0016 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/FeatureStoreFeatureValuesRequest.yaml @@ -0,0 +1,25 @@ +type : object +properties: + features: + type: object + description: A mapping from the feature alias to the feature view name and column name in the feature store in the format
File Not Found - 404 Error
The requested file was not found. '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/reports-data-extraction#get-report + label: SDK_tools/sdk/powershell/v2025/methods/reports-data-extraction#get-report source: | $TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report $FileFormat = "csv" # String | Output format of the requested report file @@ -37313,14 +53165,38 @@ paths: # Get Report File try { - Get-V2024Report -TaskResultId $TaskResultId -FileFormat $FileFormat + Get-V2025Report -TaskResultId $TaskResultId -FileFormat $FileFormat # Below is a request that includes all optional parameters - # Get-V2024Report -TaskResultId $TaskResultId -FileFormat $FileFormat -Name $Name -Auditable $Auditable + # Get-V2025Report -TaskResultId $TaskResultId -FileFormat $FileFormat -Name $Name -Auditable $Auditable } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Report" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Report" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/reports-data-extraction#get-report + source: | + from sailpoint.v2025.api.reports_data_extraction_api import ReportsDataExtractionApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + task_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Unique identifier of the task result which handled report # str | Unique identifier of the task result which handled report + file_format = 'csv' # str | Output format of the requested report file # str | Output format of the requested report file + name = 'Identities Details Report' # str | preferred Report file name, by default will be used report name from task result. (optional) # str | preferred Report file name, by default will be used report name from task result. (optional) + auditable = False # bool | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to False) # bool | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to False) + try: + # Get Report File + + results = ReportsDataExtractionApi(api_client).get_report(task_result_id=task_result_id, file_format=file_format) + # Below is a request that includes all optional parameters + # results = ReportsDataExtractionApi(api_client).get_report(task_result_id, file_format, name, auditable) + print("The response of ReportsDataExtractionApi->get_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ReportsDataExtractionApi->get_report: %s\n" % e) /sod-policies: post: security: @@ -37522,7 +53398,7 @@ paths: name: Administrator rightCriteria: $ref: '#/paths/~1sod-policies/post/requestBody/content/application~1json/schema/properties/conflictingAccessCriteria/allOf/0/properties/leftCriteria' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/AccessCriteria.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessCriteria.yaml - nullable: true examples: Conflicting Access Based Policy: @@ -37589,7 +53465,7 @@ paths: application/json: schema: $ref: '#/paths/~1sod-policies/post/requestBody/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/SodPolicy.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SodPolicy.yaml examples: Conflicting Access Based Policy: value: @@ -37659,22 +53535,22 @@ paths: modified: '2020-05-12T19:47:38Z' '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#create-sod-policy + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#create-sod-policy source: | $SodPolicy = @" { @@ -37739,14 +53615,91 @@ paths: try { $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - New-V2024SodPolicy -SodPolicy $Result + New-V2025SodPolicy -SodPolicy $Result # Below is a request that includes all optional parameters - # New-V2024SodPolicy -SodPolicy $Result + # New-V2025SodPolicy -SodPolicy $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SodPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#create-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Create SOD policy + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) + print("The response of SODPoliciesApi->create_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) get: security: - userAuth: @@ -37759,12 +53712,12 @@ paths: This gets list of all SOD policies. Requires role of ORG_ADMIN parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - in: query name: filters schema: @@ -37801,7 +53754,7 @@ paths: type: array items: $ref: '#/paths/~1sod-policies/post/requestBody/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/SodPolicy.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SodPolicy.yaml example: - id: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde name: Conflicting-Policy-Name @@ -37867,22 +53820,22 @@ paths: modified: '2020-05-12T19:47:38Z' '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#list-sod-policies + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#list-sod-policies source: | $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) @@ -37893,14 +53846,40 @@ paths: # List SOD policies try { - Get-V2024SodPolicies + Get-V2025SodPolicies # Below is a request that includes all optional parameters - # Get-V2024SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + # Get-V2025SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicies" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicies" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#list-sod-policies + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + 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) + filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # 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: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (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: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + try: + # List SOD policies + + results = SODPoliciesApi(api_client).list_sod_policies() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) + print("The response of SODPoliciesApi->list_sod_policies:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) /sod-policies/{id}: get: security: @@ -37929,7 +53908,7 @@ paths: application/json: schema: $ref: '#/paths/~1sod-policies/post/requestBody/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/SodPolicy.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SodPolicy.yaml examples: Conflicting Access Based Policy: value: @@ -37999,39 +53978,61 @@ paths: modified: '2020-05-12T19:47:38Z' '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-policy + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-policy source: | $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. # Get SOD policy by ID try { - Get-V2024SodPolicy -Id $Id + Get-V2025SodPolicy -Id $Id # Below is a request that includes all optional parameters - # Get-V2024SodPolicy -Id $Id + # Get-V2025SodPolicy -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. + try: + # Get SOD policy by ID + + results = SODPoliciesApi(api_client).get_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy(id) + print("The response of SODPoliciesApi->get_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) put: security: - userAuth: @@ -38058,7 +54059,7 @@ paths: application/json: schema: $ref: '#/paths/~1sod-policies/post/requestBody/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/SodPolicy.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SodPolicy.yaml examples: Conflicting Access Based Policy: value: @@ -38123,7 +54124,7 @@ paths: application/json: schema: $ref: '#/paths/~1sod-policies/post/requestBody/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/SodPolicy.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SodPolicy.yaml examples: Conflicting Access Based Policy: value: @@ -38193,25 +54194,25 @@ paths: modified: '2020-05-12T19:47:38Z' '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#put-sod-policy + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#put-sod-policy source: | $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. $SodPolicy = @" @@ -38277,14 +54278,92 @@ paths: try { $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - Send-V2024SodPolicy -Id $Id -SodPolicy $Result + Send-V2025SodPolicy -Id $Id -SodPolicy $Result # Below is a request that includes all optional parameters - # Send-V2024SodPolicy -Id $Id -SodPolicy $Result + # Send-V2025SodPolicy -Id $Id -SodPolicy $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SodPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#put-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Update SOD policy by ID + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) + print("The response of SODPoliciesApi->put_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) delete: security: - userAuth: @@ -38318,25 +54397,25 @@ paths: description: No content. '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#delete-sod-policy + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#delete-sod-policy source: | $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) @@ -38344,14 +54423,34 @@ paths: # Delete SOD policy by ID try { - Remove-V2024SodPolicy -Id $Id + Remove-V2025SodPolicy -Id $Id # Below is a request that includes all optional parameters - # Remove-V2024SodPolicy -Id $Id -Logical $Logical + # Remove-V2025SodPolicy -Id $Id -Logical $Logical } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SodPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#delete-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. + logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) + try: + # Delete SOD policy by ID + + SODPoliciesApi(api_client).delete_sod_policy(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy(id, logical) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) patch: security: - userAuth: @@ -38396,7 +54495,7 @@ paths: type: array items: $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/JsonPatchOperation.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml examples: Conflicting Access Based Policy: value: @@ -38425,7 +54524,7 @@ paths: application/json: schema: $ref: '#/paths/~1sod-policies/post/requestBody/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/SodPolicy.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SodPolicy.yaml examples: Conflicting Access Based Policy: value: @@ -38493,25 +54592,25 @@ paths: modified: '2020-05-12T19:47:38Z' '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#patch-sod-policy + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#patch-sod-policy source: | $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. $JsonPatchOperation = @"{ @@ -38525,14 +54624,38 @@ paths: try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024SodPolicy -Id $Id -JsonPatchOperation $Result + Update-V2025SodPolicy -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024SodPolicy -Id $Id -JsonPatchOperation $Result + # Update-V2025SodPolicy -Id $Id -JsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SodPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#patch-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2025.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. + json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + try: + # Patch SOD policy by ID + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) + print("The response of SODPoliciesApi->patch_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) /sod-policies/{id}/evaluate: post: security: @@ -38596,36 +54719,58 @@ paths: name: Multi Query Report '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-evaluate-sod-policy + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-evaluate-sod-policy source: | $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. # Evaluate one policy by ID try { - Start-V2024EvaluateSodPolicy -Id $Id + Start-V2025EvaluateSodPolicy -Id $Id # Below is a request that includes all optional parameters - # Start-V2024EvaluateSodPolicy -Id $Id + # Start-V2025EvaluateSodPolicy -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024EvaluateSodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025EvaluateSodPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-evaluate-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Evaluate one policy by ID + + results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) + print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) /sod-policies/{id}/schedule: get: security: @@ -38675,7 +54820,7 @@ paths: example: Schedule for policy xyz schedule: $ref: '#/components/schemas/ScheduledSearch/allOf/2/properties/schedule' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/schedule/Schedule.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/schedule/Schedule.yaml recipients: type: array items: @@ -38713,36 +54858,58 @@ paths: readOnly: true '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-policy-schedule + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-policy-schedule source: | $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. # Get SOD policy schedule try { - Get-V2024SodPolicySchedule -Id $Id + Get-V2025SodPolicySchedule -Id $Id # Below is a request that includes all optional parameters - # Get-V2024SodPolicySchedule -Id $Id + # Get-V2025SodPolicySchedule -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicySchedule" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicySchedule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-policy-schedule + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. + try: + # Get SOD policy schedule + + results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) + print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) put: security: - userAuth: @@ -38767,7 +54934,7 @@ paths: application/json: schema: $ref: '#/paths/~1sod-policies~1%7Bid%7D~1schedule/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/SodPolicySchedule.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SodPolicySchedule.yaml responses: '200': description: Created or updated SOD policy schedule. @@ -38775,25 +54942,25 @@ paths: application/json: schema: $ref: '#/paths/~1sod-policies~1%7Bid%7D~1schedule/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/SodPolicySchedule.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SodPolicySchedule.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#put-policy-schedule + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#put-policy-schedule source: | $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. $SodPolicySchedule = @" @@ -38889,14 +55056,122 @@ paths: try { $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule - Send-V2024PolicySchedule -Id $Id -SodPolicySchedule $Result + Send-V2025PolicySchedule -Id $Id -SodPolicySchedule $Result # Below is a request that includes all optional parameters - # Send-V2024PolicySchedule -Id $Id -SodPolicySchedule $Result + # Send-V2025PolicySchedule -Id $Id -SodPolicySchedule $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PolicySchedule" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025PolicySchedule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#put-policy-schedule + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. + sod_policy_schedule = '''{ + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + }''' # SodPolicySchedule | + try: + # Update SOD Policy schedule + new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) + results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) + print("The response of SODPoliciesApi->put_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) delete: security: - userAuth: @@ -38920,39 +55195,58 @@ paths: description: No content response. '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#delete-sod-policy-schedule + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#delete-sod-policy-schedule source: | $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. # Delete SOD policy schedule try { - Remove-V2024SodPolicySchedule -Id $Id + Remove-V2025SodPolicySchedule -Id $Id # Below is a request that includes all optional parameters - # Remove-V2024SodPolicySchedule -Id $Id + # Remove-V2025SodPolicySchedule -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicySchedule" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SodPolicySchedule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#delete-sod-policy-schedule + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. + try: + # Delete SOD policy schedule + + SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) /sod-policies/{id}/violation-report/run: post: security: @@ -38979,7 +55273,7 @@ paths: application/json: schema: $ref: '#/paths/~1sod-policies~1%7Bid%7D~1evaluate/post/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ReportResultReference.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ReportResultReference.yaml example: status: PENDING type: REPORT_RESULT @@ -38987,39 +55281,61 @@ paths: name: policy-xyz '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-sod-policy + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-sod-policy source: | $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. # Runs SOD policy violation report try { - Start-V2024SodPolicy -Id $Id + Start-V2025SodPolicy -Id $Id # Below is a request that includes all optional parameters - # Start-V2024SodPolicy -Id $Id + # Start-V2025SodPolicy -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025SodPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-sod-policy + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Runs SOD policy violation report + + results = SODPoliciesApi(api_client).start_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_policy(id) + print("The response of SODPoliciesApi->start_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) /sod-policies/{id}/violation-report: get: security: @@ -39046,7 +55362,7 @@ paths: application/json: schema: $ref: '#/paths/~1sod-policies~1%7Bid%7D~1evaluate/post/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ReportResultReference.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ReportResultReference.yaml example: status: SUCCESS type: REPORT_RESULT @@ -39054,39 +55370,61 @@ paths: name: policy-xyz '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-violation-report-status + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-violation-report-status source: | $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. # Get SOD violation report status try { - Get-V2024SodViolationReportStatus -Id $Id + Get-V2025SodViolationReportStatus -Id $Id # Below is a request that includes all optional parameters - # Get-V2024SodViolationReportStatus -Id $Id + # Get-V2025SodViolationReportStatus -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodViolationReportStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-violation-report-status + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. + try: + # Get SOD violation report status + + results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) + print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) /sod-policies/sod-violation-report-status/{reportResultId}: get: security: @@ -39113,7 +55451,7 @@ paths: application/json: schema: $ref: '#/paths/~1sod-policies~1%7Bid%7D~1evaluate/post/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ReportResultReference.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ReportResultReference.yaml example: status: SUCCESS type: REPORT_RESULT @@ -39121,39 +55459,61 @@ paths: name: policy-xyz '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-violation-report-run-status + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-violation-report-run-status source: | $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. # Get violation report run status try { - Get-V2024SodViolationReportRunStatus -ReportResultId $ReportResultId + Get-V2025SodViolationReportRunStatus -ReportResultId $ReportResultId # Below is a request that includes all optional parameters - # Get-V2024SodViolationReportRunStatus -ReportResultId $ReportResultId + # Get-V2025SodViolationReportRunStatus -ReportResultId $ReportResultId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportRunStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodViolationReportRunStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-violation-report-run-status + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. + try: + # Get violation report run status + + results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) + print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) /sod-violations/predict: post: security: @@ -39287,7 +55647,7 @@ paths: type: $ref: '#/components/schemas/Account/allOf/1/properties/ownerIdentity/allOf/0/properties/type' description: DTO type - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/DtoType.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/DtoType.yaml id: type: string description: ID of the object to which this reference applies @@ -39318,28 +55678,28 @@ paths: existing: false rightCriteria: $ref: '#/paths/~1sod-violations~1predict/post/responses/200/content/application~1json/schema/properties/violationContexts/items/properties/conflictingAccessCriteria/properties/leftCriteria' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/sod/models/ExceptionCriteria.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/sod/models/ExceptionCriteria.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-violations#start-predict-sod-violations + label: SDK_tools/sdk/powershell/v2025/methods/sod-violations#start-predict-sod-violations source: | $IdentityWithNewAccess = @" { @@ -39360,14 +55720,48 @@ paths: try { $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess - Start-V2024PredictSodViolations -IdentityWithNewAccess $Result + Start-V2025PredictSodViolations -IdentityWithNewAccess $Result # Below is a request that includes all optional parameters - # Start-V2024PredictSodViolations -IdentityWithNewAccess $Result + # Start-V2025PredictSodViolations -IdentityWithNewAccess $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024PredictSodViolations" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025PredictSodViolations" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-violations#start-predict-sod-violations + source: | + from sailpoint.v2025.api.sod_violations_api import SODViolationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_with_new_access import IdentityWithNewAccess + from sailpoint.v2025.models.violation_prediction import ViolationPrediction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access = '''{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + }''' # IdentityWithNewAccess | + try: + # Predict SOD violations for identity. + new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) + results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) + print("The response of SODViolationsApi->start_predict_sod_violations:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) /sod-violations/check: post: security: @@ -39461,25 +55855,25 @@ paths: example: '2020-01-01T00:00:00.000000Z' '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-violations#start-violation-check + label: SDK_tools/sdk/powershell/v2025/methods/sod-violations#start-violation-check source: | $IdentityWithNewAccess1 = @" {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} @@ -39489,14 +55883,37 @@ paths: try { $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 - Start-V2024ViolationCheck -IdentityWithNewAccess1 $Result + Start-V2025ViolationCheck -IdentityWithNewAccess1 $Result # Below is a request that includes all optional parameters - # Start-V2024ViolationCheck -IdentityWithNewAccess1 $Result + # Start-V2025ViolationCheck -IdentityWithNewAccess1 $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024ViolationCheck" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025ViolationCheck" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-violations#start-violation-check + source: | + from sailpoint.v2025.api.sod_violations_api import SODViolationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_with_new_access1 import IdentityWithNewAccess1 + from sailpoint.v2025.models.sod_violation_check import SodViolationCheck + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | + try: + # Check SOD violations + new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) + results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) + print("The response of SODViolationsApi->start_violation_check:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) /sod-violation-report/run: post: security: @@ -39533,7 +55950,7 @@ paths: application/json: schema: $ref: '#/paths/~1sod-policies~1%7Bid%7D~1evaluate/post/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ReportResultReference.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ReportResultReference.yaml example: status: PENDING type: REPORT_RESULT @@ -39541,22 +55958,22 @@ paths: name: Multi Query Report '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-sod-all-policies-for-org + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-sod-all-policies-for-org source: | $MultiPolicyRequest = @" { @@ -39567,14 +55984,39 @@ paths: # Runs all policies for org try { - Start-V2024SodAllPoliciesForOrg + Start-V2025SodAllPoliciesForOrg # Below is a request that includes all optional parameters - # Start-V2024SodAllPoliciesForOrg -MultiPolicyRequest $Result + # Start-V2025SodAllPoliciesForOrg -MultiPolicyRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodAllPoliciesForOrg" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025SodAllPoliciesForOrg" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#start-sod-all-policies-for-org + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.multi_policy_request import MultiPolicyRequest + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + multi_policy_request = '''{ + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + }''' # MultiPolicyRequest | (optional) + try: + # Runs all policies for org + + results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) + print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) /sod-violation-report: get: security: @@ -39592,7 +56034,7 @@ paths: application/json: schema: $ref: '#/paths/~1sod-policies~1%7Bid%7D~1evaluate/post/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ReportResultReference.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ReportResultReference.yaml example: status: SUCCESS type: REPORT_RESULT @@ -39600,35 +56042,56 @@ paths: name: Multi Query Report '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-all-report-run-status + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-all-report-run-status source: | # Get multi-report run task status try { - Get-V2024SodAllReportRunStatus + Get-V2025SodAllReportRunStatus # Below is a request that includes all optional parameters - # Get-V2024SodAllReportRunStatus + # Get-V2025SodAllReportRunStatus } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodAllReportRunStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodAllReportRunStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-sod-all-report-run-status + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get multi-report run task status + + results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) /sod-violation-report/{reportResultId}/download: get: security: @@ -39658,39 +56121,60 @@ paths: format: binary '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-default-violation-report + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-default-violation-report source: | $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. # Download violation report try { - Get-V2024DefaultViolationReport -ReportResultId $ReportResultId + Get-V2025DefaultViolationReport -ReportResultId $ReportResultId # Below is a request that includes all optional parameters - # Get-V2024DefaultViolationReport -ReportResultId $ReportResultId + # Get-V2025DefaultViolationReport -ReportResultId $ReportResultId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DefaultViolationReport" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DefaultViolationReport" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-default-violation-report + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + try: + # Download violation report + + results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) + print("The response of SODPoliciesApi->get_default_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) /sod-violation-report/{reportResultId}/download/{fileName}: get: security: @@ -39727,25 +56211,25 @@ paths: format: binary '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-custom-violation-report + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-custom-violation-report source: | $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. $FileName = "custom-name" # String | Custom Name for the file. @@ -39753,14 +56237,36 @@ paths: # Download custom violation report try { - Get-V2024CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + Get-V2025CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName # Below is a request that includes all optional parameters - # Get-V2024CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + # Get-V2025CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CustomViolationReport" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CustomViolationReport" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sod-policies#get-custom-violation-report + source: | + from sailpoint.v2025.api.sod_policies_api import SODPoliciesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. + try: + # Download custom violation report + + results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) + print("The response of SODPoliciesApi->get_custom_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) /sources: get: operationId: listSources @@ -39781,12 +56287,12 @@ paths: summary: Lists all sources in IdentityNow. description: This end-point lists all the sources in IdentityNow. parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - in: query name: filters schema: @@ -39957,7 +56463,7 @@ paths: managerCorrelationMapping: allOf: - $ref: '#/components/schemas/Source/properties/managerCorrelationMapping/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ManagerCorrelationMapping.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ManagerCorrelationMapping.yaml - nullable: true description: | Filter object used during manager correlation to match incoming manager values to an existing manager's @@ -40057,7 +56563,7 @@ paths: name: Vendor Password Policy features: $ref: '#/components/schemas/Source/properties/features' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/SourceFeature.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SourceFeature.yaml type: type: string description: 'Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. ' @@ -40176,25 +56682,25 @@ paths: - connector '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#list-sources + label: SDK_tools/sdk/powershell/v2025/methods/sources#list-sources source: | $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) @@ -40207,14 +56713,42 @@ paths: # Lists all sources in IdentityNow. try { - Get-V2024Sources + Get-V2025Sources # Below is a request that includes all optional parameters - # Get-V2024Sources -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSubadmin $ForSubadmin -IncludeIDNSource $IncludeIDNSource + # Get-V2025Sources -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSubadmin $ForSubadmin -IncludeIDNSource $IncludeIDNSource } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Sources" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Sources" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#list-sources + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.source import Source + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + 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) + filters = 'name eq \"Employees\"' # 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: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (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: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (optional) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) + for_subadmin = 'name' # str | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) # str | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) + include_idn_source = False # bool | Include the IdentityNow source in the response. (optional) (default to False) # bool | Include the IdentityNow source in the response. (optional) (default to False) + try: + # Lists all sources in IdentityNow. + + results = SourcesApi(api_client).list_sources() + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).list_sources(limit, offset, count, filters, sorters, for_subadmin, include_idn_source) + print("The response of SourcesApi->list_sources:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->list_sources: %s\n" % e) post: operationId: createSource security: @@ -40242,7 +56776,7 @@ paths: application/json: schema: $ref: '#/paths/~1sources/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/Source.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Source.yaml responses: '201': description: Created Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design. @@ -40250,25 +56784,25 @@ paths: application/json: schema: $ref: '#/paths/~1sources/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/Source.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Source.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#create-source + label: SDK_tools/sdk/powershell/v2025/methods/sources#create-source source: | $Source = @" { @@ -40361,14 +56895,119 @@ paths: try { $Result = ConvertFrom-JsonToSource -Json $Source - New-V2024Source -Source $Result + New-V2025Source -Source $Result # Below is a request that includes all optional parameters - # New-V2024Source -Source $Result -ProvisionAsCsv $ProvisionAsCsv + # New-V2025Source -Source $Result -ProvisionAsCsv $ProvisionAsCsv } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Source" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Source" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#create-source + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.source import Source + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source = '''{ + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + }''' # Source | + provision_as_csv = false # bool | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) # bool | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) + try: + # Creates a source in IdentityNow. + new_source = Source.from_json(source) + results = SourcesApi(api_client).create_source(source=new_source) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).create_source(new_source, provision_as_csv) + print("The response of SourcesApi->create_source:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->create_source: %s\n" % e) /sources/{id}: get: operationId: getSource @@ -40399,42 +57038,64 @@ paths: application/json: schema: $ref: '#/paths/~1sources/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/Source.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Source.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#get-source + label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. # Get Source by ID try { - Get-V2024Source -Id $Id + Get-V2025Source -Id $Id # Below is a request that includes all optional parameters - # Get-V2024Source -Id $Id + # Get-V2025Source -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Source" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Source" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#get-source + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.source import Source + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + try: + # Get Source by ID + + results = SourcesApi(api_client).get_source(id=id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_source(id) + print("The response of SourcesApi->get_source:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->get_source: %s\n" % e) put: operationId: putSource security: @@ -40475,7 +57136,7 @@ paths: application/json: schema: $ref: '#/paths/~1sources/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/Source.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Source.yaml responses: '200': description: Updated Source object. Any passwords will only show the the encrypted cipher-text so that they aren't decryptable in Identity Security Cloud (ISC) cloud-based services, per ISC security design. @@ -40483,28 +57144,28 @@ paths: application/json: schema: $ref: '#/paths/~1sources/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/Source.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Source.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#put-source + label: SDK_tools/sdk/powershell/v2025/methods/sources#put-source source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. $Source = @" @@ -40597,14 +57258,119 @@ paths: try { $Result = ConvertFrom-JsonToSource -Json $Source - Send-V2024Source -Id $Id -Source $Result + Send-V2025Source -Id $Id -Source $Result # Below is a request that includes all optional parameters - # Send-V2024Source -Id $Id -Source $Result + # Send-V2025Source -Id $Id -Source $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Source" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025Source" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#put-source + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.source import Source + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + source = '''{ + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + }''' # Source | + try: + # Update Source (Full) + new_source = Source.from_json(source) + results = SourcesApi(api_client).put_source(id=id, source=new_source) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).put_source(id, new_source) + print("The response of SourcesApi->put_source:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->put_source: %s\n" % e) patch: operationId: updateSource security: @@ -40651,7 +57417,7 @@ paths: type: array items: $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/JsonPatchOperation.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml examples: Edit the source description: description: This example shows how to edit a source description. @@ -40714,28 +57480,28 @@ paths: application/json: schema: $ref: '#/paths/~1sources/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/Source.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Source.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#update-source + label: SDK_tools/sdk/powershell/v2025/methods/sources#update-source source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. $JsonPatchOperation = @"{ @@ -40749,14 +57515,38 @@ paths: try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024Source -Id $Id -JsonPatchOperation $Result + Update-V2025Source -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024Source -Id $Id -JsonPatchOperation $Result + # Update-V2025Source -Id $Id -JsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Source" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Source" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#update-source + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2025.models.source import Source + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + json_patch_operation = '''[{op=replace, path=/description, value=new description}]''' # List[JsonPatchOperation] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). + try: + # Update Source (Partial) + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SourcesApi(api_client).update_source(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).update_source(id, new_json_patch_operation) + print("The response of SourcesApi->update_source:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->update_source: %s\n" % e) delete: operationId: deleteSource security: @@ -40812,39 +57602,61 @@ paths: name: null '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#delete-source + label: SDK_tools/sdk/powershell/v2025/methods/sources#delete-source source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. # Delete Source by ID try { - Remove-V2024Source -Id $Id + Remove-V2025Source -Id $Id # Below is a request that includes all optional parameters - # Remove-V2024Source -Id $Id + # Remove-V2025Source -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Source" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Source" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#delete-source + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.delete_source202_response import DeleteSource202Response + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + try: + # Delete Source by ID + + results = SourcesApi(api_client).delete_source(id=id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).delete_source(id) + print("The response of SourcesApi->delete_source:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->delete_source: %s\n" % e) /sources/{sourceId}/provisioning-policies: get: operationId: listProvisioningPolicies @@ -40892,47 +57704,69 @@ paths: example: this provisioning policy creates access based on an identity going inactive usageType: $ref: '#/components/schemas/ProvisioningPolicy/properties/usageType' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/UsageType.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/UsageType.yaml fields: type: array items: $ref: '#/components/schemas/ProvisioningPolicy/properties/fields/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/FieldDetailsDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/FieldDetailsDto.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#list-provisioning-policies + label: SDK_tools/sdk/powershell/v2025/methods/sources#list-provisioning-policies source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id # Lists ProvisioningPolicies try { - Get-V2024ProvisioningPolicies -SourceId $SourceId + Get-V2025ProvisioningPolicies -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-V2024ProvisioningPolicies -SourceId $SourceId + # Get-V2025ProvisioningPolicies -SourceId $SourceId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProvisioningPolicies" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ProvisioningPolicies" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#list-provisioning-policies + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.provisioning_policy_dto import ProvisioningPolicyDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id # str | The Source id + try: + # Lists ProvisioningPolicies + + results = SourcesApi(api_client).list_provisioning_policies(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).list_provisioning_policies(source_id) + print("The response of SourcesApi->list_provisioning_policies:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) post: operationId: createProvisioningPolicy tags: @@ -40962,7 +57796,7 @@ paths: application/json: schema: $ref: '#/paths/~1sources~1%7BsourceId%7D~1provisioning-policies/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ProvisioningPolicyDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ProvisioningPolicyDto.yaml examples: Create Account Provisioning Policy: value: @@ -41038,28 +57872,28 @@ paths: application/json: schema: $ref: '#/paths/~1sources~1%7BsourceId%7D~1provisioning-policies/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ProvisioningPolicyDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ProvisioningPolicyDto.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#create-provisioning-policy + label: SDK_tools/sdk/powershell/v2025/methods/sources#create-provisioning-policy source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id $ProvisioningPolicyDto = @" @@ -41109,14 +57943,76 @@ paths: try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - New-V2024ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result + New-V2025ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result # Below is a request that includes all optional parameters - # New-V2024ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result + # New-V2025ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ProvisioningPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ProvisioningPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#create-provisioning-policy + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.provisioning_policy_dto import ProvisioningPolicyDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id # str | The Source id + provisioning_policy_dto = '''{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + }''' # ProvisioningPolicyDto | + try: + # Create Provisioning Policy + new_provisioning_policy_dto = ProvisioningPolicyDto.from_json(provisioning_policy_dto) + results = SourcesApi(api_client).create_provisioning_policy(source_id=source_id, provisioning_policy_dto=new_provisioning_policy_dto) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).create_provisioning_policy(source_id, new_provisioning_policy_dto) + print("The response of SourcesApi->create_provisioning_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->create_provisioning_policy: %s\n" % e) /sources/{sourceId}/provisioning-policies/{usageType}: get: operationId: getProvisioningPolicy @@ -41163,7 +58059,7 @@ paths: example: CREATE schema: $ref: '#/components/schemas/ProvisioningPolicy/properties/usageType' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/UsageType.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/UsageType.yaml responses: '200': description: The requested ProvisioningPolicyDto was successfully retrieved. @@ -41171,28 +58067,28 @@ paths: application/json: schema: $ref: '#/paths/~1sources~1%7BsourceId%7D~1provisioning-policies/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ProvisioningPolicyDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ProvisioningPolicyDto.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#get-provisioning-policy + label: SDK_tools/sdk/powershell/v2025/methods/sources#get-provisioning-policy source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. @@ -41200,14 +58096,38 @@ paths: # Get Provisioning Policy by UsageType try { - Get-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + Get-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType # Below is a request that includes all optional parameters - # Get-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + # Get-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProvisioningPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ProvisioningPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#get-provisioning-policy + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.provisioning_policy_dto import ProvisioningPolicyDto + from sailpoint.v2025.models.usage_type import UsageType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. + usage_type = sailpoint.v2025.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + try: + # Get Provisioning Policy by UsageType + + results = SourcesApi(api_client).get_provisioning_policy(source_id=source_id, usage_type=usage_type) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_provisioning_policy(source_id, usage_type) + print("The response of SourcesApi->get_provisioning_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->get_provisioning_policy: %s\n" % e) put: operationId: putProvisioningPolicy tags: @@ -41252,14 +58172,14 @@ paths: example: CREATE schema: $ref: '#/components/schemas/ProvisioningPolicy/properties/usageType' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/UsageType.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/UsageType.yaml requestBody: required: true content: application/json: schema: $ref: '#/paths/~1sources~1%7BsourceId%7D~1provisioning-policies/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ProvisioningPolicyDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ProvisioningPolicyDto.yaml responses: '200': description: The ProvisioningPolicyDto was successfully replaced. @@ -41267,28 +58187,28 @@ paths: application/json: schema: $ref: '#/paths/~1sources~1%7BsourceId%7D~1provisioning-policies/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ProvisioningPolicyDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ProvisioningPolicyDto.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#put-provisioning-policy + label: SDK_tools/sdk/powershell/v2025/methods/sources#put-provisioning-policy source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. @@ -41339,14 +58259,78 @@ paths: try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - Send-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result + Send-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result # Below is a request that includes all optional parameters - # Send-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result + # Send-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ProvisioningPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ProvisioningPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#put-provisioning-policy + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.provisioning_policy_dto import ProvisioningPolicyDto + from sailpoint.v2025.models.usage_type import UsageType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. + usage_type = sailpoint.v2025.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + provisioning_policy_dto = '''{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + }''' # ProvisioningPolicyDto | + try: + # Update Provisioning Policy by UsageType + new_provisioning_policy_dto = ProvisioningPolicyDto.from_json(provisioning_policy_dto) + results = SourcesApi(api_client).put_provisioning_policy(source_id=source_id, usage_type=usage_type, provisioning_policy_dto=new_provisioning_policy_dto) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).put_provisioning_policy(source_id, usage_type, new_provisioning_policy_dto) + print("The response of SourcesApi->put_provisioning_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->put_provisioning_policy: %s\n" % e) patch: operationId: updateProvisioningPolicy tags: @@ -41389,7 +58373,7 @@ paths: example: CREATE schema: $ref: '#/components/schemas/ProvisioningPolicy/properties/usageType' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/UsageType.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/UsageType.yaml requestBody: required: true description: The JSONPatch payload used to update the schema. @@ -41399,7 +58383,7 @@ paths: type: array items: $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/JsonPatchOperation.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml examples: add-field: summary: Add a field to the beginning of the list @@ -41423,28 +58407,28 @@ paths: application/json: schema: $ref: '#/paths/~1sources~1%7BsourceId%7D~1provisioning-policies/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ProvisioningPolicyDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ProvisioningPolicyDto.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#update-provisioning-policy + label: SDK_tools/sdk/powershell/v2025/methods/sources#update-provisioning-policy source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. @@ -41459,14 +58443,40 @@ paths: try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result + Update-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result + # Update-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProvisioningPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ProvisioningPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#update-provisioning-policy + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2025.models.provisioning_policy_dto import ProvisioningPolicyDto + from sailpoint.v2025.models.usage_type import UsageType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + usage_type = sailpoint.v2025.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + json_patch_operation = '''[{op=add, path=/fields/0, value={name=email, transform={type=identityAttribute, attributes={name=email}}, attributes={}, isRequired=false, type=string, isMultiValued=false}}]''' # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. + try: + # Partial update of Provisioning Policy + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SourcesApi(api_client).update_provisioning_policy(source_id=source_id, usage_type=usage_type, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).update_provisioning_policy(source_id, usage_type, new_json_patch_operation) + print("The response of SourcesApi->update_provisioning_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->update_provisioning_policy: %s\n" % e) delete: operationId: deleteProvisioningPolicy tags: @@ -41504,32 +58514,32 @@ paths: example: CREATE schema: $ref: '#/components/schemas/ProvisioningPolicy/properties/usageType' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/UsageType.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/UsageType.yaml responses: '204': $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/204.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#delete-provisioning-policy + label: SDK_tools/sdk/powershell/v2025/methods/sources#delete-provisioning-policy source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. @@ -41537,14 +58547,35 @@ paths: # Delete Provisioning Policy by UsageType try { - Remove-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + Remove-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType # Below is a request that includes all optional parameters - # Remove-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + # Remove-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ProvisioningPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ProvisioningPolicy" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#delete-provisioning-policy + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.usage_type import UsageType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID. + usage_type = sailpoint.v2025.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + try: + # Delete Provisioning Policy by UsageType + + SourcesApi(api_client).delete_provisioning_policy(source_id=source_id, usage_type=usage_type) + # Below is a request that includes all optional parameters + # SourcesApi(api_client).delete_provisioning_policy(source_id, usage_type) + except Exception as e: + print("Exception when calling SourcesApi->delete_provisioning_policy: %s\n" % e) /sources/{sourceId}/provisioning-policies/bulk-update: post: operationId: updateProvisioningPoliciesInBulk @@ -41576,7 +58607,7 @@ paths: type: array items: $ref: '#/paths/~1sources~1%7BsourceId%7D~1provisioning-policies/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ProvisioningPolicyDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ProvisioningPolicyDto.yaml responses: '200': description: A list of the ProvisioningPolicyDto was successfully replaced. @@ -41586,28 +58617,28 @@ paths: type: array items: $ref: '#/paths/~1sources~1%7BsourceId%7D~1provisioning-policies/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ProvisioningPolicyDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ProvisioningPolicyDto.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#update-provisioning-policies-in-bulk + label: SDK_tools/sdk/powershell/v2025/methods/sources#update-provisioning-policies-in-bulk source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. $ProvisioningPolicyDto = @"{ @@ -41656,14 +58687,37 @@ paths: try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - Update-V2024ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result + Update-V2025ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result # Below is a request that includes all optional parameters - # Update-V2024ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result + # Update-V2025ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProvisioningPoliciesInBulk" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ProvisioningPoliciesInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#update-provisioning-policies-in-bulk + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.provisioning_policy_dto import ProvisioningPolicyDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + provisioning_policy_dto = '''[sailpoint.v2025.ProvisioningPolicyDto()]''' # List[ProvisioningPolicyDto] | + try: + # Bulk Update Provisioning Policies + new_provisioning_policy_dto = ProvisioningPolicyDto.from_json(provisioning_policy_dto) + results = SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id=source_id, provisioning_policy_dto=new_provisioning_policy_dto) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id, new_provisioning_policy_dto) + print("The response of SourcesApi->update_provisioning_policies_in_bulk:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) /sources/{sourceId}/schemas: get: operationId: getSourceSchemas @@ -41738,6 +58792,7 @@ paths: example: distinguishedName hierarchyAttribute: type: string + nullable: true description: The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. example: memberOf includePermissions: @@ -41746,7 +58801,7 @@ paths: example: false features: $ref: '#/components/schemas/Source/properties/features' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/SourceFeature.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SourceFeature.yaml configuration: type: object description: Holds any extra configuration data that the schema may require. @@ -41774,6 +58829,7 @@ paths: schema: description: A reference to the schema on the source to the attribute values map to. type: object + nullable: true properties: type: description: The type of object being referenced @@ -41833,30 +58889,31 @@ paths: example: '2019-12-24T22:32:58.104Z' modified: type: string + nullable: true description: The date the Schema was last modified. format: date-time example: '2019-12-31T20:22:28.104Z' '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#get-source-schemas + label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-schemas source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. $IncludeTypes = "group" # String | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) @@ -41865,14 +58922,38 @@ paths: # List Schemas on Source try { - Get-V2024SourceSchemas -SourceId $SourceId + Get-V2025SourceSchemas -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-V2024SourceSchemas -SourceId $SourceId -IncludeTypes $IncludeTypes -IncludeNames $IncludeNames + # Get-V2025SourceSchemas -SourceId $SourceId -IncludeTypes $IncludeTypes -IncludeNames $IncludeNames } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceSchemas" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceSchemas" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#get-source-schemas + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.model_schema import ModelSchema + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + include_types = 'group' # str | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) # str | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) + include_names = 'account' # str | A comma-separated list of schema names to filter result. (optional) # str | A comma-separated list of schema names to filter result. (optional) + try: + # List Schemas on Source + + results = SourcesApi(api_client).get_source_schemas(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_source_schemas(source_id, include_types, include_names) + print("The response of SourcesApi->get_source_schemas:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) post: operationId: createSourceSchema security: @@ -41901,7 +58982,7 @@ paths: application/json: schema: $ref: '#/paths/~1sources~1%7BsourceId%7D~1schemas/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/Schema.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Schema.yaml responses: '201': description: The schema was successfully created on the specified source. @@ -41909,25 +58990,25 @@ paths: application/json: schema: $ref: '#/paths/~1sources~1%7BsourceId%7D~1schemas/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/Schema.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Schema.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#create-source-schema + label: SDK_tools/sdk/powershell/v2025/methods/sources#create-source-schema source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. $Schema = @" @@ -41971,14 +59052,37 @@ paths: try { $Result = ConvertFrom-JsonToSchema -Json $Schema - New-V2024SourceSchema -SourceId $SourceId -Schema $Result + New-V2025SourceSchema -SourceId $SourceId -Schema $Result # Below is a request that includes all optional parameters - # New-V2024SourceSchema -SourceId $SourceId -Schema $Result + # New-V2025SourceSchema -SourceId $SourceId -Schema $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourceSchema" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SourceSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#create-source-schema + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.model_schema import ModelSchema + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + model_schema = '''sailpoint.v2025.ModelSchema()''' # ModelSchema | + try: + # Create Schema on Source + new_model_schema = ModelSchema.from_json(model_schema) + results = SourcesApi(api_client).create_source_schema(source_id=source_id, model_schema=new_model_schema) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).create_source_schema(source_id, new_model_schema) + print("The response of SourcesApi->create_source_schema:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->create_source_schema: %s\n" % e) /sources/{sourceId}/schedules: get: operationId: getSourceSchedules @@ -41992,7 +59096,15 @@ paths: tags: - Sources summary: List Schedules on Source - description: Use this API to list the schedules that exist on the specified source in Identity Security Cloud (ISC). + description: | + Use this API to list the schedules that exist on the specified source in Identity Security Cloud (ISC). + :::info + This endpoint uses a **cron expression** to schedule a task, following standard **cron job syntax**. + + For example, `0 0 12 1/1 * ? *` runs the task **daily at 12:00 PM**. + + **Days of the week are represented as 1-7 (Sunday-Saturday).** + ::: parameters: - in: path name: sourceId @@ -42028,39 +59140,61 @@ paths: example: 0 0 5,13,21 * * ? '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#get-source-schedules + label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-schedules source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. # List Schedules on Source try { - Get-V2024SourceSchedules -SourceId $SourceId + Get-V2025SourceSchedules -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-V2024SourceSchedules -SourceId $SourceId + # Get-V2025SourceSchedules -SourceId $SourceId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceSchedules" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceSchedules" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#get-source-schedules + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.schedule1 import Schedule1 + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + try: + # List Schedules on Source + + results = SourcesApi(api_client).get_source_schedules(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_source_schedules(source_id) + print("The response of SourcesApi->get_source_schedules:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->get_source_schedules: %s\n" % e) post: operationId: createSourceSchedule security: @@ -42090,7 +59224,7 @@ paths: application/json: schema: $ref: '#/paths/~1sources~1%7BsourceId%7D~1schedules/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/sources/Schedule.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/sources/Schedule.yaml responses: '201': description: The schedule was successfully created on the specified source. @@ -42098,25 +59232,25 @@ paths: application/json: schema: $ref: '#/paths/~1sources~1%7BsourceId%7D~1schedules/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/sources/Schedule.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/sources/Schedule.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#create-source-schedule + label: SDK_tools/sdk/powershell/v2025/methods/sources#create-source-schedule source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. $Schedule1 = @" @@ -42127,14 +59261,37 @@ paths: try { $Result = ConvertFrom-JsonToSchedule1 -Json $Schedule1 - New-V2024SourceSchedule -SourceId $SourceId -Schedule1 $Result + New-V2025SourceSchedule -SourceId $SourceId -Schedule1 $Result # Below is a request that includes all optional parameters - # New-V2024SourceSchedule -SourceId $SourceId -Schedule1 $Result + # New-V2025SourceSchedule -SourceId $SourceId -Schedule1 $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourceSchedule" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SourceSchedule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#create-source-schedule + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.schedule1 import Schedule1 + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + schedule1 = '''sailpoint.v2025.Schedule1()''' # Schedule1 | + try: + # Create Schedule on Source + new_schedule1 = Schedule1.from_json(schedule1) + results = SourcesApi(api_client).create_source_schedule(source_id=source_id, schedule1=new_schedule1) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).create_source_schedule(source_id, new_schedule1) + print("The response of SourcesApi->create_source_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->create_source_schedule: %s\n" % e) /sources/{sourceId}/schedules/{scheduleType}: get: operationId: getSourceSchedule @@ -42176,28 +59333,28 @@ paths: application/json: schema: $ref: '#/paths/~1sources~1%7BsourceId%7D~1schedules/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/sources/Schedule.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/sources/Schedule.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#get-source-schedule + label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-schedule source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. @@ -42205,14 +59362,37 @@ paths: # Get Source Schedule by Type try { - Get-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType + Get-V2025SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType # Below is a request that includes all optional parameters - # Get-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType + # Get-V2025SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceSchedule" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceSchedule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#get-source-schedule + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.schedule1 import Schedule1 + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + schedule_type = 'ACCOUNT_AGGREGATION' # str | The Schedule type. # str | The Schedule type. + try: + # Get Source Schedule by Type + + results = SourcesApi(api_client).get_source_schedule(source_id=source_id, schedule_type=schedule_type) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_source_schedule(source_id, schedule_type) + print("The response of SourcesApi->get_source_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->get_source_schedule: %s\n" % e) patch: operationId: updateSourceSchedule security: @@ -42259,7 +59439,7 @@ paths: type: array items: $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/JsonPatchOperation.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml examples: add-attribute: summary: Replace an attribute of the schedule @@ -42274,28 +59454,28 @@ paths: application/json: schema: $ref: '#/paths/~1sources~1%7BsourceId%7D~1schedules/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/sources/Schedule.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/sources/Schedule.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#update-source-schedule + label: SDK_tools/sdk/powershell/v2025/methods/sources#update-source-schedule source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. @@ -42310,14 +59490,39 @@ paths: try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -JsonPatchOperation $Result + Update-V2025SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -JsonPatchOperation $Result + # Update-V2025SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -JsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceSchedule" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SourceSchedule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#update-source-schedule + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2025.models.schedule1 import Schedule1 + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + schedule_type = 'ACCOUNT_AGGREGATION' # str | The Schedule type. # str | The Schedule type. + json_patch_operation = '''[{op=replace, path=/cronExpression, value=0 0 6 * * ?}]''' # List[JsonPatchOperation] | The JSONPatch payload used to update the schedule. + try: + # Update Source Schedule (Partial) + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SourcesApi(api_client).update_source_schedule(source_id=source_id, schedule_type=schedule_type, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).update_source_schedule(source_id, schedule_type, new_json_patch_operation) + print("The response of SourcesApi->update_source_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->update_source_schedule: %s\n" % e) delete: operationId: deleteSourceSchedule security: @@ -42352,28 +59557,28 @@ paths: responses: '204': $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/204.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#delete-source-schedule + label: SDK_tools/sdk/powershell/v2025/methods/sources#delete-source-schedule source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. @@ -42381,14 +59586,34 @@ paths: # Delete Source Schedule by type. try { - Remove-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType + Remove-V2025SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType # Below is a request that includes all optional parameters - # Remove-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType + # Remove-V2025SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SourceSchedule" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SourceSchedule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#delete-source-schedule + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + schedule_type = 'ACCOUNT_AGGREGATION' # str | The Schedule type. # str | The Schedule type. + try: + # Delete Source Schedule by type. + + SourcesApi(api_client).delete_source_schedule(source_id=source_id, schedule_type=schedule_type) + # Below is a request that includes all optional parameters + # SourcesApi(api_client).delete_source_schedule(source_id, schedule_type) + except Exception as e: + print("Exception when calling SourcesApi->delete_source_schedule: %s\n" % e) /sources/{sourceId}/schemas/{schemaId}: get: operationId: getSourceSchema @@ -42421,28 +59646,28 @@ paths: application/json: schema: $ref: '#/paths/~1sources~1%7BsourceId%7D~1schemas/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/Schema.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Schema.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#get-source-schema + label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-schema source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. @@ -42450,14 +59675,37 @@ paths: # Get Source Schema by ID try { - Get-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId + Get-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId # Below is a request that includes all optional parameters - # Get-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId + # Get-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceSchema" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#get-source-schema + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.model_schema import ModelSchema + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id. + try: + # Get Source Schema by ID + + results = SourcesApi(api_client).get_source_schema(source_id=source_id, schema_id=schema_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_source_schema(source_id, schema_id) + print("The response of SourcesApi->get_source_schema:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->get_source_schema: %s\n" % e) put: operationId: putSourceSchema tags: @@ -42497,7 +59745,7 @@ paths: application/json: schema: $ref: '#/paths/~1sources~1%7BsourceId%7D~1schemas/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/Schema.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Schema.yaml responses: '200': description: The Schema was successfully replaced. @@ -42505,28 +59753,28 @@ paths: application/json: schema: $ref: '#/paths/~1sources~1%7BsourceId%7D~1schemas/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/Schema.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Schema.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#put-source-schema + label: SDK_tools/sdk/powershell/v2025/methods/sources#put-source-schema source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. @@ -42571,14 +59819,38 @@ paths: try { $Result = ConvertFrom-JsonToSchema -Json $Schema - Send-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result + Send-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result # Below is a request that includes all optional parameters - # Send-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result + # Send-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SourceSchema" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SourceSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#put-source-schema + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.model_schema import ModelSchema + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id. + model_schema = '''sailpoint.v2025.ModelSchema()''' # ModelSchema | + try: + # Update Source Schema (Full) + new_model_schema = ModelSchema.from_json(model_schema) + results = SourcesApi(api_client).put_source_schema(source_id=source_id, schema_id=schema_id, model_schema=new_model_schema) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).put_source_schema(source_id, schema_id, new_model_schema) + print("The response of SourcesApi->put_source_schema:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->put_source_schema: %s\n" % e) patch: operationId: updateSourceSchema tags: @@ -42640,7 +59912,7 @@ paths: type: array items: $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/JsonPatchOperation.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml examples: add-attribute: summary: Add an attribute to the end of the list @@ -42662,28 +59934,28 @@ paths: application/json: schema: $ref: '#/paths/~1sources~1%7BsourceId%7D~1schemas/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/Schema.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Schema.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#update-source-schema + label: SDK_tools/sdk/powershell/v2025/methods/sources#update-source-schema source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. @@ -42698,14 +59970,39 @@ paths: try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result + Update-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result + # Update-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceSchema" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SourceSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#update-source-schema + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2025.models.model_schema import ModelSchema + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id. + json_patch_operation = '''[{op=add, path=/attributes/-, value={name=location, type=STRING, schema=null, description=Employee location, isMulti=false, isEntitlement=false, isGroup=false}}]''' # List[JsonPatchOperation] | The JSONPatch payload used to update the schema. + try: + # Update Source Schema (Partial) + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SourcesApi(api_client).update_source_schema(source_id=source_id, schema_id=schema_id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).update_source_schema(source_id, schema_id, new_json_patch_operation) + print("The response of SourcesApi->update_source_schema:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->update_source_schema: %s\n" % e) delete: operationId: deleteSourceSchema tags: @@ -42731,28 +60028,28 @@ paths: responses: '204': $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/204.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#delete-source-schema + label: SDK_tools/sdk/powershell/v2025/methods/sources#delete-source-schema source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. @@ -42760,14 +60057,34 @@ paths: # Delete Source Schema by ID try { - Remove-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId + Remove-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId # Below is a request that includes all optional parameters - # Remove-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId + # Remove-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SourceSchema" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SourceSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#delete-source-schema + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id. + try: + # Delete Source Schema by ID + + SourcesApi(api_client).delete_source_schema(source_id=source_id, schema_id=schema_id) + # Below is a request that includes all optional parameters + # SourcesApi(api_client).delete_source_schema(source_id, schema_id) + except Exception as e: + print("Exception when calling SourcesApi->delete_source_schema: %s\n" % e) /sources/{sourceId}/source-health: get: operationId: getSourceHealth @@ -42831,6 +60148,7 @@ paths: example: megapod-useast1 iqServiceVersion: type: string + nullable: true description: The version of the iqService example: iqVersion123 status: @@ -42846,43 +60164,66 @@ paths: - SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES - SOURCE_STATE_UNCHECKED_SOURCE - SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS + - SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT description: connection test result example: SOURCE_STATE_UNCHECKED_SOURCE '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#get-source-health + label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-health source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. # Fetches source health by id try { - Get-V2024SourceHealth -SourceId $SourceId + Get-V2025SourceHealth -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-V2024SourceHealth -SourceId $SourceId + # Get-V2025SourceHealth -SourceId $SourceId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceHealth" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceHealth" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#get-source-health + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.source_health_dto import SourceHealthDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + try: + # Fetches source health by id + + results = SourcesApi(api_client).get_source_health(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_source_health(source_id) + print("The response of SourcesApi->get_source_health:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->get_source_health: %s\n" % e) /sources/{id}/schemas/accounts: get: tags: @@ -42909,42 +60250,61 @@ paths: example: id,name,givenName,familyName,e-mail,location,manager,groups,startDate,endDate '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:source-schema:read x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#get-accounts-schema + label: SDK_tools/sdk/powershell/v2025/methods/sources#get-accounts-schema source: | $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id # Downloads source accounts schema template try { - Get-V2024AccountsSchema -Id $Id + Get-V2025AccountsSchema -Id $Id # Below is a request that includes all optional parameters - # Get-V2024AccountsSchema -Id $Id + # Get-V2025AccountsSchema -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountsSchema" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccountsSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#get-accounts-schema + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + try: + # Downloads source accounts schema template + + SourcesApi(api_client).get_accounts_schema(id=id) + # Below is a request that includes all optional parameters + # SourcesApi(api_client).get_accounts_schema(id) + except Exception as e: + print("Exception when calling SourcesApi->get_accounts_schema: %s\n" % e) post: tags: - Sources @@ -42984,28 +60344,28 @@ paths: application/json: schema: $ref: '#/paths/~1sources~1%7BsourceId%7D~1schemas/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/Schema.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Schema.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:source-schema:manage x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#import-accounts-schema + label: SDK_tools/sdk/powershell/v2025/methods/sources#import-accounts-schema source: | $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id $File = # System.IO.FileInfo | (optional) @@ -43013,14 +60373,37 @@ paths: # Uploads source accounts schema template try { - Import-V2024AccountsSchema -Id $Id + Import-V2025AccountsSchema -Id $Id # Below is a request that includes all optional parameters - # Import-V2024AccountsSchema -Id $Id -File $File + # Import-V2025AccountsSchema -Id $Id -File $File } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024AccountsSchema" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025AccountsSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#import-accounts-schema + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.model_schema import ModelSchema + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + file = None # bytearray | (optional) # bytearray | (optional) + try: + # Uploads source accounts schema template + + results = SourcesApi(api_client).import_accounts_schema(id=id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).import_accounts_schema(id, file) + print("The response of SourcesApi->import_accounts_schema:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->import_accounts_schema: %s\n" % e) /sources/{id}/schemas/entitlements: get: tags: @@ -43054,28 +60437,28 @@ paths: example: id,name,displayName,created,description,modified,entitlements,groups,permissions '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:source-schema:read x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#get-entitlements-schema + label: SDK_tools/sdk/powershell/v2025/methods/sources#get-entitlements-schema source: | $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) @@ -43083,14 +60466,34 @@ paths: # Downloads source entitlements schema template try { - Get-V2024EntitlementsSchema -Id $Id + Get-V2025EntitlementsSchema -Id $Id # Below is a request that includes all optional parameters - # Get-V2024EntitlementsSchema -Id $Id -SchemaName $SchemaName + # Get-V2025EntitlementsSchema -Id $Id -SchemaName $SchemaName } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementsSchema" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementsSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#get-entitlements-schema + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + schema_name = '?schemaName=group' # str | Name of entitlement schema (optional) # str | Name of entitlement schema (optional) + try: + # Downloads source entitlements schema template + + SourcesApi(api_client).get_entitlements_schema(id=id) + # Below is a request that includes all optional parameters + # SourcesApi(api_client).get_entitlements_schema(id, schema_name) + except Exception as e: + print("Exception when calling SourcesApi->get_entitlements_schema: %s\n" % e) post: tags: - Sources @@ -43136,28 +60539,28 @@ paths: application/json: schema: $ref: '#/paths/~1sources~1%7BsourceId%7D~1schemas/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/Schema.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Schema.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:source-schema:manage x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#import-entitlements-schema + label: SDK_tools/sdk/powershell/v2025/methods/sources#import-entitlements-schema source: | $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) @@ -43166,14 +60569,38 @@ paths: # Uploads source entitlements schema template try { - Import-V2024EntitlementsSchema -Id $Id + Import-V2025EntitlementsSchema -Id $Id # Below is a request that includes all optional parameters - # Import-V2024EntitlementsSchema -Id $Id -SchemaName $SchemaName -File $File + # Import-V2025EntitlementsSchema -Id $Id -SchemaName $SchemaName -File $File } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024EntitlementsSchema" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025EntitlementsSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#import-entitlements-schema + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.model_schema import ModelSchema + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + schema_name = '?schemaName=group' # str | Name of entitlement schema (optional) # str | Name of entitlement schema (optional) + file = None # bytearray | (optional) # bytearray | (optional) + try: + # Uploads source entitlements schema template + + results = SourcesApi(api_client).import_entitlements_schema(id=id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).import_entitlements_schema(id, schema_name, file) + print("The response of SourcesApi->import_entitlements_schema:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->import_entitlements_schema: %s\n" % e) /sources/{sourceId}/upload-connector-file: post: operationId: importConnectorFile @@ -43212,25 +60639,25 @@ paths: application/json: schema: $ref: '#/paths/~1sources/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/Source.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Source.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#import-connector-file + label: SDK_tools/sdk/powershell/v2025/methods/sources#import-connector-file source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. $File = # System.IO.FileInfo | (optional) @@ -43238,14 +60665,283 @@ paths: # Upload connector file to source try { - Import-V2024ConnectorFile -SourceId $SourceId + Import-V2025ConnectorFile -SourceId $SourceId # Below is a request that includes all optional parameters - # Import-V2024ConnectorFile -SourceId $SourceId -File $File + # Import-V2025ConnectorFile -SourceId $SourceId -File $File } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024ConnectorFile" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025ConnectorFile" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#import-connector-file + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.source import Source + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id. + file = None # bytearray | (optional) # bytearray | (optional) + try: + # Upload connector file to source + + results = SourcesApi(api_client).import_connector_file(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).import_connector_file(source_id, file) + print("The response of SourcesApi->import_connector_file:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->import_connector_file: %s\n" % e) + /sources/{sourceId}/connections: + get: + operationId: getSourceConnections + security: + - userAuth: + - idn:sources:read + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN + tags: + - Sources + summary: Get Source Connections by ID + description: Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC). + parameters: + - in: path + name: sourceId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSources + description: Source ID. + example: 2c9180835d191a86015d28455b4a2329 + responses: + '200': + description: Source Connections object. + content: + application/json: + schema: + type: object + properties: + identityProfiles: + type: array + description: The IdentityProfile attached to this source + items: + type: object + properties: + id: + type: string + description: ID of the IdentityProfile this reference applies + example: 76cfddb62818416f816bc494410f46c4 + name: + type: string + description: Human-readable display name of the IdentityProfile to which this reference applies + example: ODS-Identity-Profile + identityCount: + type: integer + format: int64 + description: The Number of Identities managed by this IdentityProfile + example: 100 + credentialProfiles: + type: array + description: Name of the CredentialProfile attached to this source + items: + type: string + example: + - Profile ODS + sourceAttributes: + type: array + description: The attributes attached to this source + items: + type: string + example: + - sAMAccountName + - mail + - sn + - givenName + - displayName + - employeeNumber + - manager + - telephoneNumber + mappingProfiles: + type: array + description: The profiles attached to this source + example: + - ODS-AD-Profile + - ODS-Profile2 + items: + type: string + dependentCustomTransforms: + example: + - id: 61190eae-290b-4335-aeb8-7335f1fd99cb + name: Split Transform + type: split + attributes: + delimiter: '-' + index: 1 + input: + attributes: + sourceName: Example CSV Source + attributeName: last_name + type: accountAttribute + internal: false + description: A list of custom transforms associated with this source. A transform will be considered associated with a source if any attributes of the transform specify the source as the sourceName. + type: array + items: + $ref: '#/paths/~1transforms/get/responses/200/content/application~1json/schema/items' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TransformRead.yaml + dependentApps: + type: array + items: + type: object + properties: + cloudAppId: + type: string + description: Id of the connected Application + example: 9e3cdd80edf84f119327df8bbd5bb5ac + description: + type: string + description: Description of the connected Application + example: This is a Sailpoint application + enabled: + type: boolean + description: Is the Application enabled + example: true + default: true + provisionRequestEnabled: + type: boolean + description: Is Provisioning enabled for connected Application + example: true + default: true + accountSource: + type: object + description: The Account Source of the connected Application + properties: + useForPasswordManagement: + type: boolean + description: Use this Account Source for password management + example: false + default: false + passwordPolicies: + type: array + description: A list of Password Policies for this Account Source + items: + type: object + properties: + type: + type: string + description: DTO type + example: PASSWORD_POLICY + id: + type: string + description: ID of the object to which this reference applies + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Human-readable display name of the object to which this reference applies + example: Policy ODS + launcherCount: + type: integer + format: int64 + description: The amount of launchers for connected Application (long type) + example: 100 + matchAllAccount: + type: boolean + description: Is Provisioning enabled for connected Application + example: true + default: false + owner: + type: array + description: The owner of the connected Application + items: + $ref: '#/components/schemas/Account/allOf/1/properties/ownerIdentity/allOf/0' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BaseReferenceDto.yaml + appCenterEnabled: + type: boolean + description: Is App Center enabled for connected Application + example: false + default: false + missingDependents: + type: array + items: + type: object + properties: + dependencyType: + type: string + enum: + - identityProfiles + - credentialProfiles + - mappingProfiles + - sourceAttributes + - dependantCustomTransforms + - dependantApps + description: The type of dependency type that is missing in the SourceConnections + example: dependantApps + reason: + type: string + description: The reason why this dependency is missing + example: If there was an error retrieving any dependencies, it would lbe listed here + '400': + $ref: '#/paths/~1access-profiles/get/responses/400' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml + '401': + $ref: '#/paths/~1access-profiles/get/responses/401' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml + '403': + $ref: '#/paths/~1access-profiles/get/responses/403' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml + '404': + $ref: '#/paths/~1access-requests~1cancel/post/responses/404' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml + '429': + $ref: '#/paths/~1access-profiles/get/responses/429' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml + '500': + $ref: '#/paths/~1access-profiles/get/responses/500' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml + x-codeSamples: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-connections + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # Get Source Connections by ID + + try { + Get-V2025SourceConnections -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2025SourceConnections -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceConnections" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#get-source-connections + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.source_connections_dto import SourceConnectionsDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID. + try: + # Get Source Connections by ID + + results = SourcesApi(api_client).get_source_connections(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_source_connections(source_id) + print("The response of SourcesApi->get_source_connections:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->get_source_connections: %s\n" % e) /sources/{id}/correlation-config: get: operationId: getCorrelationConfig @@ -43281,14 +60977,17 @@ paths: properties: id: type: string + nullable: true description: The ID of the correlation configuration. example: 2c9180835d191a86015d28455b4a2329 name: type: string + nullable: true description: The name of the correlation configuration. example: Source [source] Account Correlation attributeAssignments: type: array + nullable: true description: The list of attribute assignments of the correlation configuration. items: type: object @@ -43332,39 +61031,61 @@ paths: example: first_name == "John" '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#get-correlation-config + label: SDK_tools/sdk/powershell/v2025/methods/sources#get-correlation-config source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id # Get Source Correlation Configuration try { - Get-V2024CorrelationConfig -Id $Id + Get-V2025CorrelationConfig -Id $Id # Below is a request that includes all optional parameters - # Get-V2024CorrelationConfig -Id $Id + # Get-V2025CorrelationConfig -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CorrelationConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CorrelationConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#get-correlation-config + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.correlation_config import CorrelationConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id + try: + # Get Source Correlation Configuration + + results = SourcesApi(api_client).get_correlation_config(id=id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_correlation_config(id) + print("The response of SourcesApi->get_correlation_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->get_correlation_config: %s\n" % e) put: operationId: putCorrelationConfig tags: @@ -43393,7 +61114,7 @@ paths: application/json: schema: $ref: '#/paths/~1sources~1%7Bid%7D~1correlation-config/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/CorrelationConfig.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CorrelationConfig.yaml responses: '200': description: Updated correlation configuration for a source @@ -43401,28 +61122,28 @@ paths: application/json: schema: $ref: '#/paths/~1sources~1%7Bid%7D~1correlation-config/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/CorrelationConfig.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CorrelationConfig.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#put-correlation-config + label: SDK_tools/sdk/powershell/v2025/methods/sources#put-correlation-config source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id $CorrelationConfig = @" @@ -43453,14 +61174,57 @@ paths: try { $Result = ConvertFrom-JsonToCorrelationConfig -Json $CorrelationConfig - Send-V2024CorrelationConfig -Id $Id -CorrelationConfig $Result + Send-V2025CorrelationConfig -Id $Id -CorrelationConfig $Result # Below is a request that includes all optional parameters - # Send-V2024CorrelationConfig -Id $Id -CorrelationConfig $Result + # Send-V2025CorrelationConfig -Id $Id -CorrelationConfig $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024CorrelationConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025CorrelationConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#put-correlation-config + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.correlation_config import CorrelationConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id + correlation_config = '''{ + "attributeAssignments" : [ { + "filterString" : "first_name == \"John\"", + "ignoreCase" : false, + "complex" : false, + "property" : "first_name", + "value" : "firstName", + "operation" : "EQ", + "matchMode" : "ANYWHERE" + }, { + "filterString" : "first_name == \"John\"", + "ignoreCase" : false, + "complex" : false, + "property" : "first_name", + "value" : "firstName", + "operation" : "EQ", + "matchMode" : "ANYWHERE" + } ], + "name" : "Source [source] Account Correlation", + "id" : "2c9180835d191a86015d28455b4a2329" + }''' # CorrelationConfig | + try: + # Update Source Correlation Configuration + new_correlation_config = CorrelationConfig.from_json(correlation_config) + results = SourcesApi(api_client).put_correlation_config(id=id, correlation_config=new_correlation_config) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).put_correlation_config(id, new_correlation_config) + print("The response of SourcesApi->put_correlation_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->put_correlation_config: %s\n" % e) /sources/{sourceId}/password-policies: patch: operationId: updatePasswordPolicyHolders @@ -43538,31 +61302,31 @@ paths: application/json: schema: $ref: '#/paths/~1sources~1%7BsourceId%7D~1password-policies/patch/requestBody/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/PasswordPolicyHoldersDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/PasswordPolicyHoldersDto.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:sources:update x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#update-password-policy-holders + label: SDK_tools/sdk/powershell/v2025/methods/sources#update-password-policy-holders source: | $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id $PasswordPolicyHoldersDtoInner = @""@ @@ -43572,14 +61336,677 @@ paths: try { $Result = ConvertFrom-JsonToPasswordPolicyHoldersDtoInner -Json $PasswordPolicyHoldersDtoInner - Update-V2024PasswordPolicyHolders -SourceId $SourceId -PasswordPolicyHoldersDtoInner $Result + Update-V2025PasswordPolicyHolders -SourceId $SourceId -PasswordPolicyHoldersDtoInner $Result # Below is a request that includes all optional parameters - # Update-V2024PasswordPolicyHolders -SourceId $SourceId -PasswordPolicyHoldersDtoInner $Result + # Update-V2025PasswordPolicyHolders -SourceId $SourceId -PasswordPolicyHoldersDtoInner $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PasswordPolicyHolders" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025PasswordPolicyHolders" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#update-password-policy-holders + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.password_policy_holders_dto_inner import PasswordPolicyHoldersDtoInner + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id + password_policy_holders_dto_inner = '''[sailpoint.v2025.PasswordPolicyHoldersDtoInner()]''' # List[PasswordPolicyHoldersDtoInner] | + try: + # Update Password Policy + new_password_policy_holders_dto_inner = PasswordPolicyHoldersDtoInner.from_json(password_policy_holders_dto_inner) + results = SourcesApi(api_client).update_password_policy_holders(source_id=source_id, password_policy_holders_dto_inner=new_password_policy_holders_dto_inner) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).update_password_policy_holders(source_id, new_password_policy_holders_dto_inner) + print("The response of SourcesApi->update_password_policy_holders:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->update_password_policy_holders: %s\n" % e) + /sources/{sourceId}/connector/check-connection: + post: + operationId: testSourceConnection + tags: + - Sources + summary: Check connection for source connector. + description: This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. + security: + - userAuth: + - idn:source-connector:manage + x-sailpoint-userLevels: + - ORG_ADMIN + parameters: + - in: path + name: sourceId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSources + description: The ID of the Source. + example: cef3ee201db947c5912551015ba0c679 + responses: + '200': + description: The result of checking connection to the source connector with response from it. + content: + application/json: + schema: + type: object + title: Status Response + description: Response model for connection check, configuration test and ping of source connectors. + properties: + id: + type: string + description: ID of the source + example: 2c91808568c529c60168cca6f90c1313 + readOnly: true + name: + type: string + description: Name of the source + example: ODS-AD-Test [source-999999] + readOnly: true + status: + type: string + enum: + - SUCCESS + - FAILURE + description: The status of the health check. + example: SUCCESS + readOnly: true + elapsedMillis: + type: integer + description: The number of milliseconds spent on the entire request. + example: 1000 + readOnly: true + details: + type: object + description: | + The document contains the results of the health check. + The schema of this document depends on the type of source used. + readOnly: true + example: + useTLSForIQService: false + IQService: + TLS Port: 0 + .NET CLR Version: 4.0.30319.42000 + SecondaryServiceStatus: Running + Port: 5050 + Host: AUTOMATION-AD + Name: IQService + IQServiceStatus: Running + SecondaryService: IQService-Instance1-Secondary + Version: IQService Sep-2020 + secondaryPort: 5051 + OS Architecture: AMD64 + Operating System: Microsoft Windows Server 2012 R2 Standard + highestDotNetVersion: 4.8 or later + Build Time: 09/22/2020 06:34 AM -0500 + IQServiceClientAuthEnabled: false + requestProcessedOn: 1/19/2021 1:47:14 PM + '400': + $ref: '#/paths/~1access-profiles/get/responses/400' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml + '401': + $ref: '#/paths/~1access-profiles/get/responses/401' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml + '403': + $ref: '#/paths/~1access-profiles/get/responses/403' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml + '404': + $ref: '#/paths/~1access-requests~1cancel/post/responses/404' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml + '429': + $ref: '#/paths/~1access-profiles/get/responses/429' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml + '500': + $ref: '#/paths/~1access-profiles/get/responses/500' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml + x-codeSamples: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#test-source-connection + source: | + $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source. + + # Check connection for source connector. + + try { + Test-V2025SourceConnection -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Test-V2025SourceConnection -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025SourceConnection" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#test-source-connection + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.status_response import StatusResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source. # str | The ID of the Source. + try: + # Check connection for source connector. + + results = SourcesApi(api_client).test_source_connection(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).test_source_connection(source_id) + print("The response of SourcesApi->test_source_connection:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->test_source_connection: %s\n" % e) + /sources/{sourceId}/connector/peek-resource-objects: + post: + operationId: searchResourceObjects + tags: + - Sources + summary: Peek source connector's resource objects + description: Retrieves a sample of data returned from account and group aggregation requests. + security: + - userAuth: + - idn:source-connector:manage + x-sailpoint-userLevels: + - ORG_ADMIN + parameters: + - in: path + name: sourceId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSources + description: The ID of the Source + example: cef3ee201db947c5912551015ba0c679 + requestBody: + required: true + content: + application/json: + schema: + type: object + title: Resource Objects Request + description: Request model for peek resource objects from source connectors. + properties: + objectType: + type: string + description: The type of resource objects to iterate over. + default: account + example: group + maxCount: + type: integer + description: The maximum number of resource objects to iterate over and return. + default: 25 + example: 100 + responses: + '200': + description: List of resource objects that was fetched from the source connector. + content: + application/json: + schema: + type: object + title: Resource Objects Response + description: Response model for peek resource objects from source connectors. + properties: + id: + type: string + description: ID of the source + example: 2c91808568c529c60168cca6f90c1313 + readOnly: true + name: + type: string + description: Name of the source + example: ODS-AD-Test [source-999999] + readOnly: true + objectCount: + type: integer + description: The number of objects that were fetched by the connector. + example: 25 + readOnly: true + elapsedMillis: + type: integer + description: The number of milliseconds spent on the entire request. + example: 1055 + readOnly: true + resourceObjects: + type: array + items: + type: object + title: Resource Object + description: Representation of the object which is returned from source connectors. + properties: + instance: + description: Identifier of the specific instance where this object resides. + type: string + readOnly: true + identity: + description: Native identity of the object in the Source. + type: string + example: CN=Aaron Carr,OU=test1,DC=test2,DC=test + readOnly: true + uuid: + description: Universal unique identifier of the object in the Source. + type: string + example: '{abf7bd9b-68b4-4d21-9b70-870c58ebf844}' + readOnly: true + previousIdentity: + description: Native identity that the object has previously. + type: string + readOnly: true + name: + description: Display name for this object. + type: string + example: Aaron Carr + readOnly: true + objectType: + description: Type of object. + type: string + example: account + readOnly: true + incomplete: + description: A flag indicating that this is an incomplete object. Used in special cases where the connector has to return account information in several phases and the objects might not have a complete set of all account attributes. The attributes in this object will replace the corresponding attributes in the Link, but no other Link attributes will be changed. + type: boolean + example: false + readOnly: true + incremental: + description: A flag indicating that this is an incremental change object. This is similar to incomplete but it also means that the values of any multi-valued attributes in this object should be merged with the existing values in the Link rather than replacing the existing Link value. + type: boolean + example: false + readOnly: true + delete: + description: A flag indicating that this object has been deleted. This is set only when doing delta aggregation and the connector supports detection of native deletes. + type: boolean + example: false + readOnly: true + remove: + description: A flag set indicating that the values in the attributes represent things to remove rather than things to add. Setting this implies incremental. The values which are always for multi-valued attributes are removed from the current values. + type: boolean + example: false + readOnly: true + missing: + description: A list of attribute names that are not included in this object. This is only used with SMConnector and will only contain "groups". + type: array + items: + type: string + example: + - missFieldOne + - missFieldTwo + readOnly: true + attributes: + description: Attributes of this ResourceObject. + type: object + example: + telephoneNumber: 12-(345)678-9012 + mail: example@test.com + displayName: Aaron Carr + readOnly: true + finalUpdate: + description: In Aggregation, for sparse object the count for total accounts scanned identities updated is not incremented. + type: boolean + example: false + readOnly: true + description: Fetched objects from the source connector. + readOnly: true + '400': + $ref: '#/paths/~1access-profiles/get/responses/400' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml + '401': + $ref: '#/paths/~1access-profiles/get/responses/401' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml + '403': + $ref: '#/paths/~1access-profiles/get/responses/403' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml + '404': + $ref: '#/paths/~1access-requests~1cancel/post/responses/404' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml + '429': + $ref: '#/paths/~1access-profiles/get/responses/429' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml + '500': + $ref: '#/paths/~1access-profiles/get/responses/500' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml + x-codeSamples: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#search-resource-objects + source: | + $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source + $ResourceObjectsRequest = @" + { + "maxCount" : 100, + "objectType" : "group" + } + "@ + + # Peek source connector's resource objects + + try { + $Result = ConvertFrom-JsonToResourceObjectsRequest -Json $ResourceObjectsRequest + Search-V2025ResourceObjects -SourceId $SourceId -ResourceObjectsRequest $Result + + # Below is a request that includes all optional parameters + # Search-V2025ResourceObjects -SourceId $SourceId -ResourceObjectsRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025ResourceObjects" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#search-resource-objects + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.resource_objects_request import ResourceObjectsRequest + from sailpoint.v2025.models.resource_objects_response import ResourceObjectsResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source + resource_objects_request = '''{ + "maxCount" : 100, + "objectType" : "group" + }''' # ResourceObjectsRequest | + try: + # Peek source connector's resource objects + new_resource_objects_request = ResourceObjectsRequest.from_json(resource_objects_request) + results = SourcesApi(api_client).search_resource_objects(source_id=source_id, resource_objects_request=new_resource_objects_request) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).search_resource_objects(source_id, new_resource_objects_request) + print("The response of SourcesApi->search_resource_objects:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->search_resource_objects: %s\n" % e) + /sources/{sourceId}/connector/ping-cluster: + post: + operationId: pingCluster + tags: + - Sources + summary: Ping cluster for source connector + description: This endpoint validates that the cluster being used by the source is reachable from IdentityNow. + security: + - userAuth: + - idn:source-connector:manage + x-sailpoint-userLevels: + - ORG_ADMIN + parameters: + - in: path + name: sourceId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSources + description: The ID of the Source + example: cef3ee201db947c5912551015ba0c679 + responses: + '200': + description: The result of pinging connection with the source connector. + content: + application/json: + schema: + $ref: '#/paths/~1sources~1%7BsourceId%7D~1connector~1check-connection/post/responses/200/content/application~1json/schema' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/StatusResponse.yaml + '400': + $ref: '#/paths/~1access-profiles/get/responses/400' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml + '401': + $ref: '#/paths/~1access-profiles/get/responses/401' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml + '403': + $ref: '#/paths/~1access-profiles/get/responses/403' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml + '404': + $ref: '#/paths/~1access-requests~1cancel/post/responses/404' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml + '429': + $ref: '#/paths/~1access-profiles/get/responses/429' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml + '500': + $ref: '#/paths/~1access-profiles/get/responses/500' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml + x-codeSamples: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#ping-cluster + source: | + $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source + + # Ping cluster for source connector + + try { + Ping-V2025Cluster -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Ping-V2025Cluster -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-V2025Cluster" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#ping-cluster + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.status_response import StatusResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source + try: + # Ping cluster for source connector + + results = SourcesApi(api_client).ping_cluster(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).ping_cluster(source_id) + print("The response of SourcesApi->ping_cluster:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->ping_cluster: %s\n" % e) + /sources/{sourceId}/connector/test-configuration: + post: + operationId: testSourceConfiguration + tags: + - Sources + summary: Test configuration for source connector + description: This endpoint performs a more detailed validation of the source''s configuration that can take longer than the lighter weight credential validation performed by the checkConnection API. + security: + - userAuth: + - idn:source-connector:manage + x-sailpoint-userLevels: + - ORG_ADMIN + parameters: + - in: path + name: sourceId + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSources + description: The ID of the Source + example: cef3ee201db947c5912551015ba0c679 + responses: + '200': + description: The result of testing source connector configuration with response from it. + content: + application/json: + schema: + $ref: '#/paths/~1sources~1%7BsourceId%7D~1connector~1check-connection/post/responses/200/content/application~1json/schema' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/StatusResponse.yaml + '400': + $ref: '#/paths/~1access-profiles/get/responses/400' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml + '401': + $ref: '#/paths/~1access-profiles/get/responses/401' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml + '403': + $ref: '#/paths/~1access-profiles/get/responses/403' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml + '404': + $ref: '#/paths/~1access-requests~1cancel/post/responses/404' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml + '429': + $ref: '#/paths/~1access-profiles/get/responses/429' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml + '500': + $ref: '#/paths/~1access-profiles/get/responses/500' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml + x-codeSamples: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#test-source-configuration + source: | + $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source + + # Test configuration for source connector + + try { + Test-V2025SourceConfiguration -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Test-V2025SourceConfiguration -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025SourceConfiguration" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#test-source-configuration + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.status_response import StatusResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = 'cef3ee201db947c5912551015ba0c679' # str | The ID of the Source # str | The ID of the Source + try: + # Test configuration for source connector + + results = SourcesApi(api_client).test_source_configuration(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).test_source_configuration(source_id) + print("The response of SourcesApi->test_source_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->test_source_configuration: %s\n" % e) + /sources/{id}/connectors/source-config: + get: + operationId: getSourceConfig + tags: + - Sources + summary: Gets source config with language-translations + security: + - userAuth: [] + x-sailpoint-userLevels: + - ORG_ADMIN + description: Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. + parameters: + - in: path + name: id + schema: + type: string + required: true + x-sailpoint-resource-operation-id: listSources + description: The Source id + example: cef3ee201db947c5912551015ba0c679 + - in: query + name: locale + schema: + type: string + enum: + - de + - false + - fi + - sv + - ru + - pt + - ko + - zh-TW + - en + - it + - fr + - zh-CN + - hu + - es + - cs + - ja + - pl + - da + - nl + description: The locale to apply to the config. If no viable locale is given, it will default to "en" + example: en + required: false + responses: + '200': + description: A Connector Detail object + content: + application/json: + schema: + $ref: '#/paths/~1connectors~1%7BscriptName%7D/get/responses/200/content/application~1json/schema' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ConnectorDetail.yaml + '400': + $ref: '#/paths/~1access-profiles/get/responses/400' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml + '401': + $ref: '#/paths/~1access-profiles/get/responses/401' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml + '403': + $ref: '#/paths/~1access-profiles/get/responses/403' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml + '404': + $ref: '#/paths/~1access-requests~1cancel/post/responses/404' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml + '429': + $ref: '#/paths/~1access-profiles/get/responses/429' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml + '500': + $ref: '#/paths/~1access-profiles/get/responses/500' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml + x-codeSamples: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-config + source: | + $Id = "cef3ee201db947c5912551015ba0c679" # String | The Source id + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) + + # Gets source config with language-translations + + try { + Get-V2025SourceConfig -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SourceConfig -Id $Id -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceConfig" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#get-source-config + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.connector_detail import ConnectorDetail + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'cef3ee201db947c5912551015ba0c679' # str | The Source id # str | The Source id + locale = 'en' # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) + try: + # Gets source config with language-translations + + results = SourcesApi(api_client).get_source_config(id=id) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_source_config(id, locale) + print("The response of SourcesApi->get_source_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->get_source_config: %s\n" % e) /tagged-objects: get: operationId: listTaggedObjects @@ -43595,12 +62022,12 @@ paths: Any authenticated token may be used to call this API. parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - in: query name: filters schema: @@ -43663,22 +62090,22 @@ paths: - PCI '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/tagged-objects#list-tagged-objects + label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#list-tagged-objects source: | $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) @@ -43688,14 +62115,39 @@ paths: # List Tagged Objects try { - Get-V2024TaggedObjects + Get-V2025TaggedObjects # Below is a request that includes all optional parameters - # Get-V2024TaggedObjects -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + # Get-V2025TaggedObjects -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaggedObjects" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TaggedObjects" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/tagged-objects#list-tagged-objects + source: | + from sailpoint.v2025.api.tagged_objects_api import TaggedObjectsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.tagged_object import TaggedObject + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + 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) + filters = 'tagName eq \"BU_FINANCE\"' # 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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (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: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) + try: + # List Tagged Objects + + results = TaggedObjectsApi(api_client).list_tagged_objects() + # Below is a request that includes all optional parameters + # results = TaggedObjectsApi(api_client).list_tagged_objects(limit, offset, count, filters) + print("The response of TaggedObjectsApi->list_tagged_objects:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) post: operationId: setTagToObject security: @@ -43714,28 +62166,28 @@ paths: application/json: schema: $ref: '#/paths/~1tagged-objects/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/TaggedObject.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TaggedObject.yaml responses: '201': description: Created. '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/tagged-objects#set-tag-to-object + label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#set-tag-to-object source: | $TaggedObject = @" { @@ -43752,14 +62204,41 @@ paths: try { $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject - Set-V2024TagToObject -TaggedObject $Result + Set-V2025TagToObject -TaggedObject $Result # Below is a request that includes all optional parameters - # Set-V2024TagToObject -TaggedObject $Result + # Set-V2025TagToObject -TaggedObject $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TagToObject" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025TagToObject" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/tagged-objects#set-tag-to-object + source: | + from sailpoint.v2025.api.tagged_objects_api import TaggedObjectsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.tagged_object import TaggedObject + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + tagged_object = '''{ + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + }''' # TaggedObject | + try: + # Add Tag to Object + new_tagged_object = TaggedObject.from_json(tagged_object) + TaggedObjectsApi(api_client).set_tag_to_object(tagged_object=new_tagged_object) + # Below is a request that includes all optional parameters + # TaggedObjectsApi(api_client).set_tag_to_object(new_tagged_object) + except Exception as e: + print("Exception when calling TaggedObjectsApi->set_tag_to_object: %s\n" % e) /tagged-objects/{type}: get: operationId: listTaggedObjectsByType @@ -43791,12 +62270,12 @@ paths: required: true description: The type of tagged object to retrieve. example: ROLE - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - in: query name: filters schema: @@ -43820,25 +62299,25 @@ paths: type: array items: $ref: '#/paths/~1tagged-objects/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/TaggedObject.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TaggedObject.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/tagged-objects#list-tagged-objects-by-type + label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#list-tagged-objects-by-type source: | $Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. $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) @@ -43849,14 +62328,40 @@ paths: # List Tagged Objects by Type try { - Get-V2024TaggedObjectsByType -Type $Type + Get-V2025TaggedObjectsByType -Type $Type # Below is a request that includes all optional parameters - # Get-V2024TaggedObjectsByType -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + # Get-V2025TaggedObjectsByType -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaggedObjectsByType" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TaggedObjectsByType" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/tagged-objects#list-tagged-objects-by-type + source: | + from sailpoint.v2025.api.tagged_objects_api import TaggedObjectsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.tagged_object import TaggedObject + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + type = 'ROLE' # str | The type of tagged object to retrieve. # str | The type of tagged object to retrieve. + 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) + filters = 'objectRef.id eq \"2c91808568c529c60168cca6f90c1313\"' # 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: **objectRef.id**: *eq* **objectRef.type**: *eq* (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: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) + try: + # List Tagged Objects by Type + + results = TaggedObjectsApi(api_client).list_tagged_objects_by_type(type=type) + # Below is a request that includes all optional parameters + # results = TaggedObjectsApi(api_client).list_tagged_objects_by_type(type, limit, offset, count, filters) + print("The response of TaggedObjectsApi->list_tagged_objects_by_type:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) /tagged-objects/{type}/{id}: get: operationId: getTaggedObject @@ -43900,25 +62405,25 @@ paths: application/json: schema: $ref: '#/paths/~1tagged-objects/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/TaggedObject.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TaggedObject.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/tagged-objects#get-tagged-object + label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#get-tagged-object source: | $Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. @@ -43926,14 +62431,37 @@ paths: # Get Tagged Object try { - Get-V2024TaggedObject -Type $Type -Id $Id + Get-V2025TaggedObject -Type $Type -Id $Id # Below is a request that includes all optional parameters - # Get-V2024TaggedObject -Type $Type -Id $Id + # Get-V2025TaggedObject -Type $Type -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaggedObject" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TaggedObject" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/tagged-objects#get-tagged-object + source: | + from sailpoint.v2025.api.tagged_objects_api import TaggedObjectsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.tagged_object import TaggedObject + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + type = 'ROLE' # str | The type of tagged object to retrieve. # str | The type of tagged object to retrieve. + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the object reference to retrieve. # str | The ID of the object reference to retrieve. + try: + # Get Tagged Object + + results = TaggedObjectsApi(api_client).get_tagged_object(type=type, id=id) + # Below is a request that includes all optional parameters + # results = TaggedObjectsApi(api_client).get_tagged_object(type, id) + print("The response of TaggedObjectsApi->get_tagged_object:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling TaggedObjectsApi->get_tagged_object: %s\n" % e) put: operationId: putTaggedObject security: @@ -43974,7 +62502,7 @@ paths: application/json: schema: $ref: '#/paths/~1tagged-objects/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/TaggedObject.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TaggedObject.yaml responses: '200': description: Tagged object by type and ID. @@ -43982,25 +62510,25 @@ paths: application/json: schema: $ref: '#/paths/~1tagged-objects/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/TaggedObject.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TaggedObject.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/tagged-objects#put-tagged-object + label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#put-tagged-object source: | $Type = "ACCESS_PROFILE" # String | The type of tagged object to update. $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to update. @@ -44019,14 +62547,45 @@ paths: try { $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject - Send-V2024TaggedObject -Type $Type -Id $Id -TaggedObject $Result + Send-V2025TaggedObject -Type $Type -Id $Id -TaggedObject $Result # Below is a request that includes all optional parameters - # Send-V2024TaggedObject -Type $Type -Id $Id -TaggedObject $Result + # Send-V2025TaggedObject -Type $Type -Id $Id -TaggedObject $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TaggedObject" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025TaggedObject" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/tagged-objects#put-tagged-object + source: | + from sailpoint.v2025.api.tagged_objects_api import TaggedObjectsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.tagged_object import TaggedObject + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + type = 'ROLE' # str | The type of tagged object to update. # str | The type of tagged object to update. + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the object reference to update. # str | The ID of the object reference to update. + tagged_object = '''{ + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + }''' # TaggedObject | + try: + # Update Tagged Object + new_tagged_object = TaggedObject.from_json(tagged_object) + results = TaggedObjectsApi(api_client).put_tagged_object(type=type, id=id, tagged_object=new_tagged_object) + # Below is a request that includes all optional parameters + # results = TaggedObjectsApi(api_client).put_tagged_object(type, id, new_tagged_object) + print("The response of TaggedObjectsApi->put_tagged_object:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling TaggedObjectsApi->put_tagged_object: %s\n" % e) delete: operationId: deleteTaggedObject security: @@ -44066,22 +62625,22 @@ paths: description: No content. '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/tagged-objects#delete-tagged-object + label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#delete-tagged-object source: | $Type = "ACCESS_PROFILE" # String | The type of object to delete tags from. $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object to delete tags from. @@ -44089,14 +62648,34 @@ paths: # Delete Object Tags try { - Remove-V2024TaggedObject -Type $Type -Id $Id + Remove-V2025TaggedObject -Type $Type -Id $Id # Below is a request that includes all optional parameters - # Remove-V2024TaggedObject -Type $Type -Id $Id + # Remove-V2025TaggedObject -Type $Type -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024TaggedObject" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025TaggedObject" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/tagged-objects#delete-tagged-object + source: | + from sailpoint.v2025.api.tagged_objects_api import TaggedObjectsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + type = 'ROLE' # str | The type of object to delete tags from. # str | The type of object to delete tags from. + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the object to delete tags from. # str | The ID of the object to delete tags from. + try: + # Delete Object Tags + + TaggedObjectsApi(api_client).delete_tagged_object(type=type, id=id) + # Below is a request that includes all optional parameters + # TaggedObjectsApi(api_client).delete_tagged_object(type, id) + except Exception as e: + print("Exception when calling TaggedObjectsApi->delete_tagged_object: %s\n" % e) /tagged-objects/bulk-add: post: operationId: setTagsToManyObjects @@ -44129,7 +62708,7 @@ paths: type: array items: $ref: '#/paths/~1tagged-objects/get/responses/200/content/application~1json/schema/items/properties/objectRef' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/TaggedObjectDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TaggedObjectDto.yaml tags: type: array items: @@ -44163,7 +62742,7 @@ paths: type: array items: $ref: '#/paths/~1tagged-objects/get/responses/200/content/application~1json/schema/items/properties/objectRef' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/TaggedObjectDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TaggedObjectDto.yaml tags: type: array items: @@ -44174,22 +62753,22 @@ paths: - PCI '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/tagged-objects#set-tags-to-many-objects + label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#set-tags-to-many-objects source: | $BulkAddTaggedObject = @" { @@ -44211,14 +62790,49 @@ paths: try { $Result = ConvertFrom-JsonToBulkAddTaggedObject -Json $BulkAddTaggedObject - Set-V2024TagsToManyObjects -BulkAddTaggedObject $Result + Set-V2025TagsToManyObjects -BulkAddTaggedObject $Result # Below is a request that includes all optional parameters - # Set-V2024TagsToManyObjects -BulkAddTaggedObject $Result + # Set-V2025TagsToManyObjects -BulkAddTaggedObject $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TagsToManyObjects" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025TagsToManyObjects" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/tagged-objects#set-tags-to-many-objects + source: | + from sailpoint.v2025.api.tagged_objects_api import TaggedObjectsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.bulk_add_tagged_object import BulkAddTaggedObject + from sailpoint.v2025.models.bulk_tagged_object_response import BulkTaggedObjectResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + bulk_add_tagged_object = '''{ + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] + }''' # BulkAddTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + try: + # Tag Multiple Objects + new_bulk_add_tagged_object = BulkAddTaggedObject.from_json(bulk_add_tagged_object) + results = TaggedObjectsApi(api_client).set_tags_to_many_objects(bulk_add_tagged_object=new_bulk_add_tagged_object) + # Below is a request that includes all optional parameters + # results = TaggedObjectsApi(api_client).set_tags_to_many_objects(new_bulk_add_tagged_object) + print("The response of TaggedObjectsApi->set_tags_to_many_objects:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e) /tagged-objects/bulk-remove: post: operationId: deleteTagsToManyObject @@ -44251,7 +62865,7 @@ paths: type: array items: $ref: '#/paths/~1tagged-objects/get/responses/200/content/application~1json/schema/items/properties/objectRef' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/TaggedObjectDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TaggedObjectDto.yaml tags: type: array items: @@ -44263,25 +62877,25 @@ paths: responses: '204': $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/204.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/tagged-objects#delete-tags-to-many-object + label: SDK_tools/sdk/powershell/v2025/methods/tagged-objects#delete-tags-to-many-object source: | $BulkRemoveTaggedObject = @" { @@ -44302,14 +62916,45 @@ paths: try { $Result = ConvertFrom-JsonToBulkRemoveTaggedObject -Json $BulkRemoveTaggedObject - Remove-V2024TagsToManyObject -BulkRemoveTaggedObject $Result + Remove-V2025TagsToManyObject -BulkRemoveTaggedObject $Result # Below is a request that includes all optional parameters - # Remove-V2024TagsToManyObject -BulkRemoveTaggedObject $Result + # Remove-V2025TagsToManyObject -BulkRemoveTaggedObject $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024TagsToManyObject" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025TagsToManyObject" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/tagged-objects#delete-tags-to-many-object + source: | + from sailpoint.v2025.api.tagged_objects_api import TaggedObjectsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.bulk_remove_tagged_object import BulkRemoveTaggedObject + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + bulk_remove_tagged_object = '''{ + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "tags" : [ "BU_FINANCE", "PCI" ] + }''' # BulkRemoveTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + try: + # Remove Tags from Multiple Objects + new_bulk_remove_tagged_object = BulkRemoveTaggedObject.from_json(bulk_remove_tagged_object) + TaggedObjectsApi(api_client).delete_tags_to_many_object(bulk_remove_tagged_object=new_bulk_remove_tagged_object) + # Below is a request that includes all optional parameters + # TaggedObjectsApi(api_client).delete_tags_to_many_object(new_bulk_remove_tagged_object) + except Exception as e: + print("Exception when calling TaggedObjectsApi->delete_tags_to_many_object: %s\n" % e) /transforms: get: tags: @@ -44319,11 +62964,11 @@ paths: operationId: listTransforms parameters: - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - name: name in: query description: Name of the transform to retrieve from the list. @@ -44358,7 +63003,7 @@ paths: items: allOf: - $ref: '#/paths/~1transforms/post/requestBody/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/Transform.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Transform.yaml - type: object required: - id @@ -44390,22 +63035,22 @@ paths: internal: true '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:transform:read @@ -44414,7 +63059,7 @@ paths: - ORG_ADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/transforms#list-transforms + label: SDK_tools/sdk/powershell/v2025/methods/transforms#list-transforms source: | $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) $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) @@ -44425,14 +63070,40 @@ paths: # List transforms try { - Get-V2024Transforms + Get-V2025Transforms # Below is a request that includes all optional parameters - # Get-V2024Transforms -Offset $Offset -Limit $Limit -Count $Count -Name $Name -Filters $Filters + # Get-V2025Transforms -Offset $Offset -Limit $Limit -Count $Count -Name $Name -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Transforms" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Transforms" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/transforms#list-transforms + source: | + from sailpoint.v2025.api.transforms_api import TransformsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.transform_read import TransformRead + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + 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) + 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) + 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) + name = 'ExampleTransformName123' # str | Name of the transform to retrieve from the list. (optional) # str | Name of the transform to retrieve from the list. (optional) + filters = 'name eq \"Uppercase\"' # 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: **internal**: *eq* **name**: *eq, sw* (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: **internal**: *eq* **name**: *eq, sw* (optional) + try: + # List transforms + + results = TransformsApi(api_client).list_transforms() + # Below is a request that includes all optional parameters + # results = TransformsApi(api_client).list_transforms(offset, limit, count, name, filters) + print("The response of TransformsApi->list_transforms:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling TransformsApi->list_transforms: %s\n" % e) post: tags: - Transforms @@ -44506,67 +63177,67 @@ paths: description: Meta-data about the transform. Values in this list are specific to the type of transform to be executed. oneOf: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/AccountAttribute.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/AccountAttribute.yaml - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/Base64Decode.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/Base64Decode.yaml - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/Base64Encode.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/Base64Encode.yaml - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/Concatenation.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/Concatenation.yaml - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/4' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/Conditional.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/Conditional.yaml - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/5' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/DateCompare.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/DateCompare.yaml - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/6' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/DateFormat.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/DateFormat.yaml - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/7' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/DateMath.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/DateMath.yaml - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/8' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/DecomposeDiacriticalMarks.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/DecomposeDiacriticalMarks.yaml - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/9' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/E164phone.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/E164phone.yaml - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/10' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/FirstValid.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/FirstValid.yaml - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/11' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/Rule.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/Rule.yaml - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/12' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/IdentityAttribute.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/IdentityAttribute.yaml - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/13' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/IndexOf.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/IndexOf.yaml - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/14' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/ISO3166.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/ISO3166.yaml - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/15' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/LeftPad.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/LeftPad.yaml - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/16' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/Lookup.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/Lookup.yaml - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/17' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/Lower.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/Lower.yaml - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/18' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/NameNormalizer.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/NameNormalizer.yaml - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/19' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/RandomAlphaNumeric.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RandomAlphaNumeric.yaml - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/20' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/RandomNumeric.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RandomNumeric.yaml - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/21' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/Reference.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/Reference.yaml - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/22' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/ReplaceAll.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/ReplaceAll.yaml - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/23' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/Replace.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/Replace.yaml - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/24' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/RightPad.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RightPad.yaml - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/25' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/Split.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/Split.yaml - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/26' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/Static.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/Static.yaml - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/27' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/Substring.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/Substring.yaml - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/28' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/Trim.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/Trim.yaml - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/29' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/Upper.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/Upper.yaml - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/30' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/UUIDGenerator.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/UUIDGenerator.yaml example: name: Timestamp To Date type: dateFormat @@ -44580,25 +63251,25 @@ paths: application/json: schema: $ref: '#/paths/~1transforms/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/TransformRead.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TransformRead.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:transform:manage @@ -44606,7 +63277,7 @@ paths: - ORG_ADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/transforms#create-transform + label: SDK_tools/sdk/powershell/v2025/methods/transforms#create-transform source: | $Transform = @" { @@ -44636,14 +63307,41 @@ paths: try { $Result = ConvertFrom-JsonToTransform -Json $Transform - New-V2024Transform -Transform $Result + New-V2025Transform -Transform $Result # Below is a request that includes all optional parameters - # New-V2024Transform -Transform $Result + # New-V2025Transform -Transform $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Transform" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Transform" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/transforms#create-transform + source: | + from sailpoint.v2025.api.transforms_api import TransformsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.transform import Transform + from sailpoint.v2025.models.transform_read import TransformRead + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + transform = '''{ + "name" : "Timestamp To Date", + "attributes" : "{}", + "type" : "dateFormat" + }''' # Transform | The transform to be created. + try: + # Create transform + new_transform = Transform.from_json(transform) + results = TransformsApi(api_client).create_transform(transform=new_transform) + # Below is a request that includes all optional parameters + # results = TransformsApi(api_client).create_transform(new_transform) + print("The response of TransformsApi->create_transform:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling TransformsApi->create_transform: %s\n" % e) /transforms/{id}: get: tags: @@ -44669,25 +63367,25 @@ paths: application/json: schema: $ref: '#/paths/~1transforms/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/TransformRead.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TransformRead.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:transform:read @@ -44696,21 +63394,43 @@ paths: - ORG_ADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/transforms#get-transform + label: SDK_tools/sdk/powershell/v2025/methods/transforms#get-transform source: | $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve # Transform by ID try { - Get-V2024Transform -Id $Id + Get-V2025Transform -Id $Id # Below is a request that includes all optional parameters - # Get-V2024Transform -Id $Id + # Get-V2025Transform -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Transform" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Transform" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/transforms#get-transform + source: | + from sailpoint.v2025.api.transforms_api import TransformsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.transform_read import TransformRead + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to retrieve # str | ID of the transform to retrieve + try: + # Transform by ID + + results = TransformsApi(api_client).get_transform(id=id) + # Below is a request that includes all optional parameters + # results = TransformsApi(api_client).get_transform(id) + print("The response of TransformsApi->get_transform:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling TransformsApi->get_transform: %s\n" % e) put: tags: - Transforms @@ -44734,7 +63454,7 @@ paths: application/json: schema: $ref: '#/paths/~1transforms/post/requestBody/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/Transform.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Transform.yaml example: name: Timestamp To Date type: dateFormat @@ -44748,7 +63468,7 @@ paths: application/json: schema: $ref: '#/paths/~1transforms/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/TransformRead.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TransformRead.yaml example: id: 2cd78adghjkja34jh2b1hkjhasuecd name: Timestamp To Date @@ -44759,22 +63479,22 @@ paths: internal: false '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:transform:manage @@ -44782,7 +63502,7 @@ paths: - ORG_ADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/transforms#update-transform + label: SDK_tools/sdk/powershell/v2025/methods/transforms#update-transform source: | $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to update $Transform = @" @@ -44812,14 +63532,42 @@ paths: # Update a transform try { - Update-V2024Transform -Id $Id + Update-V2025Transform -Id $Id # Below is a request that includes all optional parameters - # Update-V2024Transform -Id $Id -Transform $Result + # Update-V2025Transform -Id $Id -Transform $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Transform" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Transform" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/transforms#update-transform + source: | + from sailpoint.v2025.api.transforms_api import TransformsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.transform import Transform + from sailpoint.v2025.models.transform_read import TransformRead + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to update # str | ID of the transform to update + transform = '''{ + "name" : "Timestamp To Date", + "attributes" : "{}", + "type" : "dateFormat" + }''' # Transform | The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. (optional) + try: + # Update a transform + + results = TransformsApi(api_client).update_transform(id=id) + # Below is a request that includes all optional parameters + # results = TransformsApi(api_client).update_transform(id, new_transform) + print("The response of TransformsApi->update_transform:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling TransformsApi->update_transform: %s\n" % e) delete: tags: - Transforms @@ -44840,25 +63588,25 @@ paths: responses: '204': $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/204.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:transform:manage @@ -44866,21 +63614,40 @@ paths: - ORG_ADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/transforms#delete-transform + label: SDK_tools/sdk/powershell/v2025/methods/transforms#delete-transform source: | $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to delete # Delete a transform try { - Remove-V2024Transform -Id $Id + Remove-V2025Transform -Id $Id # Below is a request that includes all optional parameters - # Remove-V2024Transform -Id $Id + # Remove-V2025Transform -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Transform" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Transform" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/transforms#delete-transform + source: | + from sailpoint.v2025.api.transforms_api import TransformsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to delete # str | ID of the transform to delete + try: + # Delete a transform + + TransformsApi(api_client).delete_transform(id=id) + # Below is a request that includes all optional parameters + # TransformsApi(api_client).delete_transform(id) + except Exception as e: + print("Exception when calling TransformsApi->delete_transform: %s\n" % e) /work-items: get: operationId: listWorkItems @@ -44889,12 +63656,12 @@ paths: summary: List Work Items description: This gets a collection of work items belonging to either the specified user(admin required), or the current user. parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - in: query name: ownerId schema: @@ -44952,23 +63719,23 @@ paths: example: Create account on source 'AD' state: $ref: '#/components/schemas/WorkItems/properties/state' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/WorkItemStateManualWorkItems.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/WorkItemStateManualWorkItems.yaml type: $ref: '#/components/schemas/WorkItems/properties/type' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/WorkItemTypeManualWorkItems.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/WorkItemTypeManualWorkItems.yaml remediationItems: type: array nullable: true items: $ref: '#/components/schemas/WorkItems/properties/remediationItems/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/RemediationItemDetails.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RemediationItemDetails.yaml description: A list of remediation items approvalItems: type: array nullable: true items: $ref: '#/components/schemas/WorkItems/properties/approvalItems/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ApprovalItemDetails.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ApprovalItemDetails.yaml description: A list of items that need to be approved name: type: string @@ -44990,7 +63757,7 @@ paths: form: allOf: - $ref: '#/components/schemas/WorkItems/properties/form/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/FormDetails.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/FormDetails.yaml - nullable: true errors: type: array @@ -45001,22 +63768,22 @@ paths: description: An array of errors that ocurred during the work item '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#list-work-items + label: SDK_tools/sdk/powershell/v2025/methods/work-items#list-work-items source: | $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) @@ -45026,14 +63793,39 @@ paths: # List Work Items try { - Get-V2024WorkItems + Get-V2025WorkItems # Below is a request that includes all optional parameters - # Get-V2024WorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId + # Get-V2025WorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItems" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-items#list-work-items + source: | + from sailpoint.v2025.api.work_items_api import WorkItemsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + 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) + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # List Work Items + + results = WorkItemsApi(api_client).list_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id) + print("The response of WorkItemsApi->list_work_items:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) /work-items/completed: get: operationId: getCompletedWorkItems @@ -45049,12 +63841,12 @@ paths: description: The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. required: false example: 1211bcaa32112bcef6122adb21cef1ac - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml responses: '200': description: List of completed work items. @@ -45064,25 +63856,25 @@ paths: type: array items: $ref: '#/paths/~1work-items/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/WorkItems.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/WorkItems.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-completed-work-items + label: SDK_tools/sdk/powershell/v2025/methods/work-items#get-completed-work-items source: | $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (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) @@ -45092,14 +63884,39 @@ paths: # Completed Work Items try { - Get-V2024CompletedWorkItems + Get-V2025CompletedWorkItems # Below is a request that includes all optional parameters - # Get-V2024CompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count + # Get-V2025CompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompletedWorkItems" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CompletedWorkItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-items#get-completed-work-items + source: | + from sailpoint.v2025.api.work_items_api import WorkItemsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (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: + # Completed Work Items + + results = WorkItemsApi(api_client).get_completed_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count) + print("The response of WorkItemsApi->get_completed_work_items:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) /work-items/count: get: operationId: getCountWorkItems @@ -45129,36 +63946,58 @@ paths: example: 29 '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-count-work-items + label: SDK_tools/sdk/powershell/v2025/methods/work-items#get-count-work-items source: | $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) # Count Work Items try { - Get-V2024CountWorkItems + Get-V2025CountWorkItems # Below is a request that includes all optional parameters - # Get-V2024CountWorkItems -OwnerId $OwnerId + # Get-V2025CountWorkItems -OwnerId $OwnerId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CountWorkItems" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CountWorkItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-items#get-count-work-items + source: | + from sailpoint.v2025.api.work_items_api import WorkItemsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.work_items_count import WorkItemsCount + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + owner_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Count Work Items + + results = WorkItemsApi(api_client).get_count_work_items() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_count_work_items(owner_id) + print("The response of WorkItemsApi->get_count_work_items:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e) /work-items/completed/count: get: operationId: getCountCompletedWorkItems @@ -45187,22 +64026,20 @@ paths: content: application/json: schema: - type: array - items: - $ref: '#/paths/~1work-items~1count/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/WorkItemsCount.yaml + $ref: '#/paths/~1work-items~1count/get/responses/200/content/application~1json/schema' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/WorkItemsCount.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-count-completed-work-items + label: SDK_tools/sdk/powershell/v2025/methods/work-items#get-count-completed-work-items source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) @@ -45210,14 +64047,38 @@ paths: # Count Completed Work Items try { - Get-V2024CountCompletedWorkItems -XSailPointExperimental $XSailPointExperimental + Get-V2025CountCompletedWorkItems -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024CountCompletedWorkItems -XSailPointExperimental $XSailPointExperimental -OwnerId $OwnerId + # Get-V2025CountCompletedWorkItems -XSailPointExperimental $XSailPointExperimental -OwnerId $OwnerId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CountCompletedWorkItems" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CountCompletedWorkItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-items#get-count-completed-work-items + source: | + from sailpoint.v2025.api.work_items_api import WorkItemsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.work_items_count import WorkItemsCount + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Count Completed Work Items + + results = WorkItemsApi(api_client).get_count_completed_work_items(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_count_completed_work_items(x_sail_point_experimental, owner_id) + print("The response of WorkItemsApi->get_count_completed_work_items:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) /work-items/summary: get: operationId: getWorkItemsSummary @@ -45255,36 +64116,58 @@ paths: example: 30 '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-work-items-summary + label: SDK_tools/sdk/powershell/v2025/methods/work-items#get-work-items-summary source: | $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) # Work Items Summary try { - Get-V2024WorkItemsSummary + Get-V2025WorkItemsSummary # Below is a request that includes all optional parameters - # Get-V2024WorkItemsSummary -OwnerId $OwnerId + # Get-V2025WorkItemsSummary -OwnerId $OwnerId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItemsSummary" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkItemsSummary" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-items#get-work-items-summary + source: | + from sailpoint.v2025.api.work_items_api import WorkItemsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.work_items_summary import WorkItemsSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional) + try: + # Work Items Summary + + results = WorkItemsApi(api_client).get_work_items_summary() + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_work_items_summary(owner_id) + print("The response of WorkItemsApi->get_work_items_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e) /work-items/{id}: get: operationId: getWorkItem @@ -45308,39 +64191,61 @@ paths: application/json: schema: $ref: '#/paths/~1work-items/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/WorkItems.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/WorkItems.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-work-item + label: SDK_tools/sdk/powershell/v2025/methods/work-items#get-work-item source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. # Get a Work Item try { - Get-V2024WorkItem -Id $Id + Get-V2025WorkItem -Id $Id # Below is a request that includes all optional parameters - # Get-V2024WorkItem -Id $Id + # Get-V2025WorkItem -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItem" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkItem" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-items#get-work-item + source: | + from sailpoint.v2025.api.work_items_api import WorkItemsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180835d191a86015d28455b4a2329' # str | ID of the work item. # str | ID of the work item. + try: + # Get a Work Item + + results = WorkItemsApi(api_client).get_work_item(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).get_work_item(id) + print("The response of WorkItemsApi->get_work_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e) post: operationId: completeWorkItem tags: @@ -45356,6 +64261,13 @@ paths: x-sailpoint-resource-operation-id: listWorkItems description: The ID of the work item example: ef38f94347e94562b5bb8424a56397d8 + requestBody: + description: Body is the request payload to create form definition request + content: + application/json: + schema: + type: string + nullable: true responses: '200': description: A WorkItems object @@ -45363,42 +64275,66 @@ paths: application/json: schema: $ref: '#/paths/~1work-items/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/WorkItems.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/WorkItems.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#complete-work-item + label: SDK_tools/sdk/powershell/v2025/methods/work-items#complete-work-item source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $Body = "MyBody" # String | Body is the request payload to create form definition request (optional) # Complete a Work Item try { - Complete-V2024WorkItem -Id $Id + Complete-V2025WorkItem -Id $Id # Below is a request that includes all optional parameters - # Complete-V2024WorkItem -Id $Id + # Complete-V2025WorkItem -Id $Id -Body $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024WorkItem" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2025WorkItem" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-items#complete-work-item + source: | + from sailpoint.v2025.api.work_items_api import WorkItemsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + body = 'body_example' # str | Body is the request payload to create form definition request (optional) # str | Body is the request payload to create form definition request (optional) + try: + # Complete a Work Item + + results = WorkItemsApi(api_client).complete_work_item(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).complete_work_item(id, new_body) + print("The response of WorkItemsApi->complete_work_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e) /work-items/{id}/approve/{approvalItemId}: post: operationId: approveApprovalItem @@ -45429,28 +64365,28 @@ paths: application/json: schema: $ref: '#/paths/~1work-items/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/WorkItems.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/WorkItems.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#approve-approval-item + label: SDK_tools/sdk/powershell/v2025/methods/work-items#approve-approval-item source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. @@ -45458,14 +64394,37 @@ paths: # Approve an Approval Item try { - Approve-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + Approve-V2025ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId # Below is a request that includes all optional parameters - # Approve-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + # Approve-V2025ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024ApprovalItem" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2025ApprovalItem" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-items#approve-approval-item + source: | + from sailpoint.v2025.api.work_items_api import WorkItemsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item. + try: + # Approve an Approval Item + + results = WorkItemsApi(api_client).approve_approval_item(id=id, approval_item_id=approval_item_id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).approve_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->approve_approval_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e) /work-items/{id}/reject/{approvalItemId}: post: operationId: rejectApprovalItem @@ -45496,28 +64455,28 @@ paths: application/json: schema: $ref: '#/paths/~1work-items/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/WorkItems.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/WorkItems.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#reject-approval-item + label: SDK_tools/sdk/powershell/v2025/methods/work-items#reject-approval-item source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. @@ -45525,14 +64484,37 @@ paths: # Reject an Approval Item try { - Deny-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + Deny-V2025ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId # Below is a request that includes all optional parameters - # Deny-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + # Deny-V2025ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024ApprovalItem" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2025ApprovalItem" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-items#reject-approval-item + source: | + from sailpoint.v2025.api.work_items_api import WorkItemsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item. + try: + # Reject an Approval Item + + results = WorkItemsApi(api_client).reject_approval_item(id=id, approval_item_id=approval_item_id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).reject_approval_item(id, approval_item_id) + print("The response of WorkItemsApi->reject_approval_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e) /work-items/bulk-approve/{id}: post: operationId: approveApprovalItemsInBulk @@ -45556,42 +64538,64 @@ paths: application/json: schema: $ref: '#/paths/~1work-items/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/WorkItems.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/WorkItems.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#approve-approval-items-in-bulk + label: SDK_tools/sdk/powershell/v2025/methods/work-items#approve-approval-items-in-bulk source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item # Bulk approve Approval Items try { - Approve-V2024ApprovalItemsInBulk -Id $Id + Approve-V2025ApprovalItemsInBulk -Id $Id # Below is a request that includes all optional parameters - # Approve-V2024ApprovalItemsInBulk -Id $Id + # Approve-V2025ApprovalItemsInBulk -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024ApprovalItemsInBulk" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2025ApprovalItemsInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-items#approve-approval-items-in-bulk + source: | + from sailpoint.v2025.api.work_items_api import WorkItemsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Bulk approve Approval Items + + results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id) + print("The response of WorkItemsApi->approve_approval_items_in_bulk:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->approve_approval_items_in_bulk: %s\n" % e) /work-items/bulk-reject/{id}: post: operationId: rejectApprovalItemsInBulk @@ -45615,42 +64619,64 @@ paths: application/json: schema: $ref: '#/paths/~1work-items/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/WorkItems.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/WorkItems.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#reject-approval-items-in-bulk + label: SDK_tools/sdk/powershell/v2025/methods/work-items#reject-approval-items-in-bulk source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item # Bulk reject Approval Items try { - Deny-V2024ApprovalItemsInBulk -Id $Id + Deny-V2025ApprovalItemsInBulk -Id $Id # Below is a request that includes all optional parameters - # Deny-V2024ApprovalItemsInBulk -Id $Id + # Deny-V2025ApprovalItemsInBulk -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024ApprovalItemsInBulk" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2025ApprovalItemsInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-items#reject-approval-items-in-bulk + source: | + from sailpoint.v2025.api.work_items_api import WorkItemsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + try: + # Bulk reject Approval Items + + results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id=id) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id) + print("The response of WorkItemsApi->reject_approval_items_in_bulk:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->reject_approval_items_in_bulk: %s\n" % e) /work-items/{id}/submit-account-selection: post: operationId: submitAccountSelection @@ -45684,28 +64710,28 @@ paths: application/json: schema: $ref: '#/paths/~1work-items/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/WorkItems.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/WorkItems.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#submit-account-selection + label: SDK_tools/sdk/powershell/v2025/methods/work-items#submit-account-selection source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName @@ -45714,14 +64740,37 @@ paths: try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Submit-V2024AccountSelection -Id $Id -RequestBody $Result + Submit-V2025AccountSelection -Id $Id -RequestBody $Result # Below is a request that includes all optional parameters - # Submit-V2024AccountSelection -Id $Id -RequestBody $Result + # Submit-V2025AccountSelection -Id $Id -RequestBody $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024AccountSelection" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2025AccountSelection" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-items#submit-account-selection + source: | + from sailpoint.v2025.api.work_items_api import WorkItemsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.work_items import WorkItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + request_body = {fieldName=fieldValue} # Dict[str, object] | Account Selection Data map, keyed on fieldName # Dict[str, object] | Account Selection Data map, keyed on fieldName + try: + # Submit Account Selections + new_request_body = RequestBody.from_json(request_body) + results = WorkItemsApi(api_client).submit_account_selection(id=id, request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = WorkItemsApi(api_client).submit_account_selection(id, new_request_body) + print("The response of WorkItemsApi->submit_account_selection:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e) /workflows: get: operationId: listWorkflows @@ -45802,38 +64851,59 @@ paths: description: Workflow creator's display name. example: Michael Michaels - $ref: '#/paths/~1workflows/post/requestBody/content/application~1json/schema/allOf/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/workflows/WorkflowBody.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/workflows/WorkflowBody.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflows + label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflows source: | # List Workflows try { - Get-V2024Workflows + Get-V2025Workflows # Below is a request that includes all optional parameters - # Get-V2024Workflows + # Get-V2025Workflows } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflows" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Workflows" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflows + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Workflows + + results = WorkflowsApi(api_client).list_workflows() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflows() + print("The response of WorkflowsApi->list_workflows:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) post: operationId: createWorkflow tags: @@ -45942,18 +65012,27 @@ paths: type: string description: The unique ID of the trigger example: idn:identity-attributes-changed + nullable: true filter.$: type: string description: JSON path expression that will limit which events the trigger will fire on example: $.changes[?(@.attribute == 'manager')] + nullable: true description: type: string description: Description of the event trigger example: Triggered when an identity's manager attribute changes + nullable: true attributeToFilter: type: string description: The attribute to filter on example: LifecycleState + nullable: true + formDefinitionId: + type: string + description: Form definition's unique identifier. + example: Admin_Access_Request_Form + nullable: true - title: External Trigger Attributes type: object description: Attributes related to an external trigger @@ -45963,18 +65042,22 @@ paths: type: string description: A unique name for the external trigger example: search-and-notify + nullable: true description: type: string - description: Additonal context about the external trigger + description: Additional context about the external trigger example: Run a search and notify the results + nullable: true clientId: type: string description: OAuth Client ID to authenticate with this trigger example: 87e239b2-b85b-4bde-b9a7-55bf304ddcdc + nullable: true url: type: string description: URL to invoke this workflow example: https://tenant.api.identitynow.com/beta/workflows/execute/external/c79e0079-562c-4df5-aa73-60a9e25c916d + nullable: true - title: Scheduled Trigger Attributes type: object description: Attributes related to a scheduled trigger @@ -45982,6 +65065,23 @@ paths: required: - frequency properties: + frequency: + type: string + description: Frequency of execution + example: daily + enum: + - daily + - weekly + - monthly + - yearly + - cronSchedule + - null + nullable: true + timeZone: + type: string + description: Time zone identifier + example: America/Chicago + nullable: true cronString: type: string description: A valid CRON expression @@ -45989,31 +65089,28 @@ paths: description: CRON expression editor url: https://crontab.guru/ example: 0 9 * * 1 - frequency: - type: string - description: Frequency of execution - enum: - - daily - - weekly - - monthly - - yearly - - cronSchedule - timeZone: - type: string - description: Time zone identifier - example: America/Chicago + nullable: true weeklyDays: type: array items: type: string example: Monday description: Scheduled days of the week for execution + nullable: true weeklyTimes: type: array items: type: string example: Monday description: Scheduled execution times + nullable: true + yearlyTimes: + type: array + items: + type: string + example: '1969-12-31T09:00:00.000Z' + description: Scheduled execution times + nullable: true description: Workflow Trigger Attributes. examples: Event Trigger: @@ -46112,25 +65209,25 @@ paths: application/json: schema: $ref: '#/paths/~1workflows/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/workflows/Workflow.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/workflows/Workflow.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-workflow + label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-workflow source: | $CreateWorkflowRequest = @" {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} @@ -46140,14 +65237,37 @@ paths: try { $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest - New-V2024Workflow -CreateWorkflowRequest $Result + New-V2025Workflow -CreateWorkflowRequest $Result # Below is a request that includes all optional parameters - # New-V2024Workflow -CreateWorkflowRequest $Result + # New-V2025Workflow -CreateWorkflowRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Workflow" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#create-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.create_workflow_request import CreateWorkflowRequest + from sailpoint.v2025.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest | + try: + # Create Workflow + new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request) + results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request) + print("The response of WorkflowsApi->create_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e) /workflows/{id}: get: operationId: getWorkflow @@ -46175,39 +65295,61 @@ paths: application/json: schema: $ref: '#/paths/~1workflows/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/workflows/Workflow.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/workflows/Workflow.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow + label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow # Get Workflow By Id try { - Get-V2024Workflow -Id $Id + Get-V2025Workflow -Id $Id # Below is a request that includes all optional parameters - # Get-V2024Workflow -Id $Id + # Get-V2025Workflow -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Workflow" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Get Workflow By Id + + results = WorkflowsApi(api_client).get_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow(id) + print("The response of WorkflowsApi->get_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e) put: operationId: putWorkflow tags: @@ -46233,7 +65375,7 @@ paths: application/json: schema: $ref: '#/paths/~1workflows/post/requestBody/content/application~1json/schema/allOf/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/workflows/WorkflowBody.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/workflows/WorkflowBody.yaml responses: '200': description: The Workflow object @@ -46241,25 +65383,25 @@ paths: application/json: schema: $ref: '#/paths/~1workflows/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/workflows/Workflow.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/workflows/Workflow.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#put-workflow + label: SDK_tools/sdk/powershell/v2025/methods/workflows#put-workflow source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow $WorkflowBody = @" @@ -46294,6 +65436,7 @@ paths: "displayName" : "displayName", "attributes" : { "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", "attributeToFilter" : "LifecycleState", "id" : "idn:identity-attributes-changed", "filter.$" : "$.changes[?(@.attribute == 'manager')]" @@ -46308,14 +65451,77 @@ paths: try { $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody - Send-V2024Workflow -Id $Id -WorkflowBody $Result + Send-V2025Workflow -Id $Id -WorkflowBody $Result # Below is a request that includes all optional parameters - # Send-V2024Workflow -Id $Id -WorkflowBody $Result + # Send-V2025Workflow -Id $Id -WorkflowBody $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Workflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025Workflow" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#put-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow import Workflow + from sailpoint.v2025.models.workflow_body import WorkflowBody + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + workflow_body = '''{ + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + }''' # WorkflowBody | + try: + # Update Workflow + new_workflow_body = WorkflowBody.from_json(workflow_body) + results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) + print("The response of WorkflowsApi->put_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) patch: operationId: patchWorkflow tags: @@ -46343,7 +65549,7 @@ paths: type: array items: $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/JsonPatchOperation.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml examples: Update all patchable fields: description: Demonstrate how to update each patchable field in one PATCH request. @@ -46393,25 +65599,25 @@ paths: application/json: schema: $ref: '#/paths/~1workflows/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/workflows/Workflow.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/workflows/Workflow.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#patch-workflow + label: SDK_tools/sdk/powershell/v2025/methods/workflows#patch-workflow source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow $JsonPatchOperation = @"{ @@ -46425,14 +65631,38 @@ paths: try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024Workflow -Id $Id -JsonPatchOperation $Result + Update-V2025Workflow -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024Workflow -Id $Id -JsonPatchOperation $Result + # Update-V2025Workflow -Id $Id -JsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Workflow" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#patch-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2025.models.workflow import Workflow + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] | + try: + # Patch Workflow + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation) + print("The response of WorkflowsApi->patch_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e) delete: operationId: deleteWorkflow tags: @@ -46455,39 +65685,58 @@ paths: responses: '204': $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/204.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#delete-workflow + label: SDK_tools/sdk/powershell/v2025/methods/workflows#delete-workflow source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow # Delete Workflow By Id try { - Remove-V2024Workflow -Id $Id + Remove-V2025Workflow -Id $Id # Below is a request that includes all optional parameters - # Remove-V2024Workflow -Id $Id + # Remove-V2025Workflow -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Workflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Workflow" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#delete-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + try: + # Delete Workflow By Id + + WorkflowsApi(api_client).delete_workflow(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).delete_workflow(id) + except Exception as e: + print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e) /workflows/{id}/test: post: operationId: testWorkflow @@ -46562,22 +65811,22 @@ paths: example: 0e11cefa-96e7-4b67-90d0-065bc1da5753 '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#test-workflow + label: SDK_tools/sdk/powershell/v2025/methods/workflows#test-workflow source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow $TestWorkflowRequest = @" @@ -46588,14 +65837,38 @@ paths: try { $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest - Test-V2024Workflow -Id $Id -TestWorkflowRequest $Result + Test-V2025Workflow -Id $Id -TestWorkflowRequest $Result # Below is a request that includes all optional parameters - # Test-V2024Workflow -Id $Id -TestWorkflowRequest $Result + # Test-V2025Workflow -Id $Id -TestWorkflowRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024Workflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025Workflow" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#test-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.test_workflow200_response import TestWorkflow200Response + from sailpoint.v2025.models.test_workflow_request import TestWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | + try: + # Test Workflow By Id + new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) + results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) + print("The response of WorkflowsApi->test_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) /workflows/{id}/executions: get: operationId: getWorkflowExecutions @@ -46627,12 +65900,12 @@ paths: schema: type: string example: c17bea3a-574d-453c-9e04-4365fbf5af0b - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - in: query name: filters schema: @@ -46690,25 +65963,25 @@ paths: example: Completed '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-executions + label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-executions source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. $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) @@ -46719,14 +65992,40 @@ paths: # List Workflow Executions try { - Get-V2024WorkflowExecutions -Id $Id + Get-V2025WorkflowExecutions -Id $Id # Below is a request that includes all optional parameters - # Get-V2024WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + # Get-V2025WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutions" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecutions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-executions + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow_execution import WorkflowExecution + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID. + 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) + filters = 'status eq \"Failed\"' # 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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + try: + # List Workflow Executions + + results = WorkflowsApi(api_client).get_workflow_executions(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) + print("The response of WorkflowsApi->get_workflow_executions:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) /workflow-executions/{id}: get: operationId: getWorkflowExecution @@ -46755,42 +66054,63 @@ paths: schema: items: $ref: '#/paths/~1workflows~1%7Bid%7D~1executions/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/workflows/WorkflowExecution.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/workflows/WorkflowExecution.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution + label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-execution source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. # Get Workflow Execution try { - Get-V2024WorkflowExecution -Id $Id + Get-V2025WorkflowExecution -Id $Id # Below is a request that includes all optional parameters - # Get-V2024WorkflowExecution -Id $Id + # Get-V2025WorkflowExecution -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecution" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecution" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-execution + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID. + try: + # Get Workflow Execution + + results = WorkflowsApi(api_client).get_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution(id) + print("The response of WorkflowsApi->get_workflow_execution:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e) /workflow-executions/{id}/history: get: operationId: getWorkflowExecutionHistory @@ -46853,39 +66173,61 @@ paths: example: {} '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution-history + label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-execution-history source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution # Get Workflow Execution History try { - Get-V2024WorkflowExecutionHistory -Id $Id + Get-V2025WorkflowExecutionHistory -Id $Id # Below is a request that includes all optional parameters - # Get-V2024WorkflowExecutionHistory -Id $Id + # Get-V2025WorkflowExecutionHistory -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutionHistory" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecutionHistory" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#get-workflow-execution-history + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow_execution_event import WorkflowExecutionEvent + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution + try: + # Get Workflow Execution History + + results = WorkflowsApi(api_client).get_workflow_execution_history(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).get_workflow_execution_history(id) + print("The response of WorkflowsApi->get_workflow_execution_history:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) /workflow-executions/{id}/cancel: post: operationId: cancelWorkflowExecution @@ -46909,42 +66251,61 @@ paths: responses: '204': $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/204.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#cancel-workflow-execution + label: SDK_tools/sdk/powershell/v2025/methods/workflows#cancel-workflow-execution source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID # Cancel Workflow Execution by ID try { - Suspend-V2024WorkflowExecution -Id $Id + Suspend-V2025WorkflowExecution -Id $Id # Below is a request that includes all optional parameters - # Suspend-V2024WorkflowExecution -Id $Id + # Suspend-V2025WorkflowExecution -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024WorkflowExecution" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2025WorkflowExecution" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#cancel-workflow-execution + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID + try: + # Cancel Workflow Execution by ID + + WorkflowsApi(api_client).cancel_workflow_execution(id=id) + # Below is a request that includes all optional parameters + # WorkflowsApi(api_client).cancel_workflow_execution(id) + except Exception as e: + print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e) /workflow-library: get: operationId: listCompleteWorkflowLibrary @@ -46956,10 +66317,10 @@ paths: description: Additional documentation for workflows url: https://documentation.sailpoint.com/saas/help/workflows/workflow-steps.html parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml security: - userAuth: - sp:workflow:read @@ -47236,7 +66597,7 @@ paths: example: [] items: $ref: '#/paths/~1workflow-library/get/responses/200/content/application~1json/schema/items/anyOf/0/properties/formFields/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/workflows/WorkflowLibraryFormFields.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/workflows/WorkflowLibraryFormFields.yaml - title: Workflow Operator type: object properties: @@ -47273,7 +66634,7 @@ paths: description: One or more inputs that the operator accepts items: $ref: '#/paths/~1workflow-library/get/responses/200/content/application~1json/schema/items/anyOf/0/properties/formFields/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/workflows/WorkflowLibraryFormFields.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/workflows/WorkflowLibraryFormFields.yaml example: - description: Enter the JSONPath to a value from the input to compare to Variable B. helpText: '' @@ -47303,22 +66664,22 @@ paths: type: text '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-complete-workflow-library + label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-complete-workflow-library source: | $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) @@ -47326,14 +66687,37 @@ paths: # List Complete Workflow Library try { - Get-V2024CompleteWorkflowLibrary + Get-V2025CompleteWorkflowLibrary # Below is a request that includes all optional parameters - # Get-V2024CompleteWorkflowLibrary -Limit $Limit -Offset $Offset + # Get-V2025CompleteWorkflowLibrary -Limit $Limit -Offset $Offset } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompleteWorkflowLibrary" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CompleteWorkflowLibrary" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#list-complete-workflow-library + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + 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) + try: + # List Complete Workflow Library + + results = WorkflowsApi(api_client).list_complete_workflow_library() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) + print("The response of WorkflowsApi->list_complete_workflow_library:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) /workflow-library/actions: get: operationId: listWorkflowLibraryActions @@ -47345,10 +66729,10 @@ paths: description: Additional documentation for each action url: https://documentation.sailpoint.com/saas/help/workflows/workflow-steps.html#actions parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - in: query name: filters required: false @@ -47373,25 +66757,25 @@ paths: type: array items: $ref: '#/paths/~1workflow-library/get/responses/200/content/application~1json/schema/items/anyOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/workflows/WorkflowLibraryAction.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/workflows/WorkflowLibraryAction.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-actions + label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-actions source: | $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) @@ -47400,14 +66784,38 @@ paths: # List Workflow Library Actions try { - Get-V2024WorkflowLibraryActions + Get-V2025WorkflowLibraryActions # Below is a request that includes all optional parameters - # Get-V2024WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters + # Get-V2025WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryActions" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryActions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-actions + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow_library_action import WorkflowLibraryAction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + 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) + filters = 'id eq \"sp:create-campaign\"' # 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: **id**: *eq* (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: **id**: *eq* (optional) + try: + # List Workflow Library Actions + + results = WorkflowsApi(api_client).list_workflow_library_actions() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_actions:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) /workflow-library/triggers: get: operationId: listWorkflowLibraryTriggers @@ -47419,10 +66827,10 @@ paths: description: Additional documentation for each trigger url: https://documentation.sailpoint.com/saas/help/workflows/workflow-steps.html#triggers parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - in: query name: filters required: false @@ -47447,25 +66855,25 @@ paths: type: array items: $ref: '#/paths/~1workflow-library/get/responses/200/content/application~1json/schema/items/anyOf/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/workflows/WorkflowLibraryTrigger.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/workflows/WorkflowLibraryTrigger.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-triggers + label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-triggers source: | $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) @@ -47474,14 +66882,38 @@ paths: # List Workflow Library Triggers try { - Get-V2024WorkflowLibraryTriggers + Get-V2025WorkflowLibraryTriggers # Below is a request that includes all optional parameters - # Get-V2024WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters + # Get-V2025WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryTriggers" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryTriggers" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-triggers + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow_library_trigger import WorkflowLibraryTrigger + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + 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) + filters = 'id eq \"idn:identity-attributes-changed\"' # 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: **id**: *eq* (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: **id**: *eq* (optional) + try: + # List Workflow Library Triggers + + results = WorkflowsApi(api_client).list_workflow_library_triggers() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) + print("The response of WorkflowsApi->list_workflow_library_triggers:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) /workflow-library/operators: get: operationId: listWorkflowLibraryOperators @@ -47501,38 +66933,59 @@ paths: type: array items: $ref: '#/paths/~1workflow-library/get/responses/200/content/application~1json/schema/items/anyOf/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/workflows/WorkflowLibraryOperator.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/workflows/WorkflowLibraryOperator.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-operators + label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-operators source: | # List Workflow Library Operators try { - Get-V2024WorkflowLibraryOperators + Get-V2025WorkflowLibraryOperators # Below is a request that includes all optional parameters - # Get-V2024WorkflowLibraryOperators + # Get-V2025WorkflowLibraryOperators } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryOperators" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryOperators" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#list-workflow-library-operators + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow_library_operator import WorkflowLibraryOperator + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Workflow Library Operators + + results = WorkflowsApi(api_client).list_workflow_library_operators() + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).list_workflow_library_operators() + print("The response of WorkflowsApi->list_workflow_library_operators:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) /workflows/{id}/external/oauth-clients: post: operationId: createWorkflowExternalTrigger @@ -47575,36 +67028,58 @@ paths: example: https://tenant.api.identitynow.com/beta/workflows/execute/external/c17bea3a-574d-453c-9e04-4365fbf5af0b '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-workflow-external-trigger + label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-workflow-external-trigger source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow # Generate External Trigger OAuth Client try { - New-V2024WorkflowExternalTrigger -Id $Id + New-V2025WorkflowExternalTrigger -Id $Id # Below is a request that includes all optional parameters - # New-V2024WorkflowExternalTrigger -Id $Id + # New-V2025WorkflowExternalTrigger -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024WorkflowExternalTrigger" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025WorkflowExternalTrigger" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#create-workflow-external-trigger + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workflow_o_auth_client import WorkflowOAuthClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + try: + # Generate External Trigger OAuth Client + + results = WorkflowsApi(api_client).create_workflow_external_trigger(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_workflow_external_trigger(id) + print("The response of WorkflowsApi->create_workflow_external_trigger:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e) /workflows/execute/external/{id}: post: operationId: createExternalExecuteWorkflow @@ -47656,22 +67131,22 @@ paths: example: Workflow was not executed externally. Check enabled flag on workflow definition '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-external-execute-workflow + label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-external-execute-workflow source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow $CreateExternalExecuteWorkflowRequest = @" @@ -47681,14 +67156,38 @@ paths: # Execute Workflow via External Trigger try { - New-V2024ExternalExecuteWorkflow -Id $Id + New-V2025ExternalExecuteWorkflow -Id $Id # Below is a request that includes all optional parameters - # New-V2024ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result + # New-V2025ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ExternalExecuteWorkflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ExternalExecuteWorkflow" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#create-external-execute-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.create_external_execute_workflow200_response import CreateExternalExecuteWorkflow200Response + from sailpoint.v2025.models.create_external_execute_workflow_request import CreateExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + create_external_execute_workflow_request = '''sailpoint.v2025.CreateExternalExecuteWorkflowRequest()''' # CreateExternalExecuteWorkflowRequest | (optional) + try: + # Execute Workflow via External Trigger + + results = WorkflowsApi(api_client).create_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).create_external_execute_workflow(id, new_create_external_execute_workflow_request) + print("The response of WorkflowsApi->create_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e) /workflows/execute/external/{id}/test: post: operationId: testExternalExecuteWorkflow @@ -47736,22 +67235,22 @@ paths: test: hello world '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#test-external-execute-workflow + label: SDK_tools/sdk/powershell/v2025/methods/workflows#test-external-execute-workflow source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow $TestExternalExecuteWorkflowRequest = @" @@ -47761,14 +67260,38 @@ paths: # Test Workflow via External Trigger try { - Test-V2024ExternalExecuteWorkflow -Id $Id + Test-V2025ExternalExecuteWorkflow -Id $Id # Below is a request that includes all optional parameters - # Test-V2024ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result + # Test-V2025ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ExternalExecuteWorkflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025ExternalExecuteWorkflow" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/workflows#test-external-execute-workflow + source: | + from sailpoint.v2025.api.workflows_api import WorkflowsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response + from sailpoint.v2025.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_external_execute_workflow_request = '''sailpoint.v2025.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) + try: + # Test Workflow via External Trigger + + results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) + print("The response of WorkflowsApi->test_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) /source-usages/{sourceId}/status: get: tags: @@ -47810,36 +67333,58 @@ paths: - INCOMPLETE '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/source-usages#get-status-by-source-id + label: SDK_tools/sdk/powershell/v2025/methods/source-usages#get-status-by-source-id source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source # Finds status of source usage try { - Get-V2024StatusBySourceId -SourceId $SourceId + Get-V2025StatusBySourceId -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-V2024StatusBySourceId -SourceId $SourceId + # Get-V2025StatusBySourceId -SourceId $SourceId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024StatusBySourceId" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025StatusBySourceId" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/source-usages#get-status-by-source-id + source: | + from sailpoint.v2025.api.source_usages_api import SourceUsagesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.source_usage_status import SourceUsageStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + try: + # Finds status of source usage + + results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourceUsagesApi(api_client).get_status_by_source_id(source_id) + print("The response of SourceUsagesApi->get_status_by_source_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e) /source-usages/{sourceId}/summaries: get: tags: @@ -47856,12 +67401,12 @@ paths: schema: type: string example: 2c9180835d191a86015d28455b4a2329 - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - in: query name: sorters schema: @@ -47897,22 +67442,22 @@ paths: example: 10.45 '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/source-usages#get-usages-by-source-id + label: SDK_tools/sdk/powershell/v2025/methods/source-usages#get-usages-by-source-id source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source $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) @@ -47923,14 +67468,40 @@ paths: # Returns source usage insights try { - Get-V2024UsagesBySourceId -SourceId $SourceId + Get-V2025UsagesBySourceId -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-V2024UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + # Get-V2025UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesBySourceId" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UsagesBySourceId" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/source-usages#get-usages-by-source-id + source: | + from sailpoint.v2025.api.source_usages_api import SourceUsagesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.source_usage import SourceUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source + 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) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns source usage insights + + results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id) + # Below is a request that includes all optional parameters + # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) + print("The response of SourceUsagesApi->get_usages_by_source_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) /account-usages/{accountId}/summaries: get: tags: @@ -47947,12 +67518,12 @@ paths: schema: type: string example: ef38f94347e94562b5bb8424a56397d8 - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - in: query name: sorters schema: @@ -47988,22 +67559,22 @@ paths: example: 10 '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/account-usages#get-usages-by-account-id + label: SDK_tools/sdk/powershell/v2025/methods/account-usages#get-usages-by-account-id source: | $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account $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) @@ -48014,14 +67585,40 @@ paths: # Returns account usage insights try { - Get-V2024UsagesByAccountId -AccountId $AccountId + Get-V2025UsagesByAccountId -AccountId $AccountId # Below is a request that includes all optional parameters - # Get-V2024UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + # Get-V2025UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesByAccountId" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UsagesByAccountId" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/account-usages#get-usages-by-account-id + source: | + from sailpoint.v2025.api.account_usages_api import AccountUsagesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.account_usage import AccountUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account + 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) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns account usage insights + + results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) + # Below is a request that includes all optional parameters + # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) + print("The response of AccountUsagesApi->get_usages_by_account_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) /identity-profiles/identity-preview: post: operationId: generateIdentityPreview @@ -48044,7 +67641,7 @@ paths: description: The Identity id identityAttributeConfig: $ref: '#/components/schemas/IdentityProfile/allOf/1/properties/identityAttributeConfig' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/IdentityAttributeConfig.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/IdentityAttributeConfig.yaml responses: '200': description: Object representing the preview object with all of the identity attributes using the current mappings. @@ -48091,22 +67688,22 @@ paths: errorMessages: $ref: '#/paths/~1access-request-status/get/responses/200/content/application~1json/schema/items/properties/errorMessages/items' description: A list of errors that may have been encountered. - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ErrorMessageDtoList.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ErrorMessageDtoList.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:identity-profile:manage @@ -48123,7 +67720,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#generate-identity-preview + label: SDK_tools/sdk/powershell/v2025/methods/identity-profiles#generate-identity-preview source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $IdentityPreviewRequest = @" @@ -48160,14 +67757,65 @@ paths: try { $Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest - New-V2024IdentityPreview -XSailPointExperimental $XSailPointExperimental -IdentityPreviewRequest $Result + New-V2025IdentityPreview -XSailPointExperimental $XSailPointExperimental -IdentityPreviewRequest $Result # Below is a request that includes all optional parameters - # New-V2024IdentityPreview -XSailPointExperimental $XSailPointExperimental -IdentityPreviewRequest $Result + # New-V2025IdentityPreview -XSailPointExperimental $XSailPointExperimental -IdentityPreviewRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024IdentityPreview" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025IdentityPreview" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/identity-profiles#generate-identity-preview + source: | + from sailpoint.v2025.api.identity_profiles_api import IdentityProfilesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_preview_request import IdentityPreviewRequest + from sailpoint.v2025.models.identity_preview_response import IdentityPreviewResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + identity_preview_request = '''{ + "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + } + }''' # IdentityPreviewRequest | Identity Preview request body. + try: + # Generate Identity Profile Preview + new_identity_preview_request = IdentityPreviewRequest.from_json(identity_preview_request) + results = IdentityProfilesApi(api_client).generate_identity_preview(x_sail_point_experimental=x_sail_point_experimental, identity_preview_request=new_identity_preview_request) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).generate_identity_preview(x_sail_point_experimental, new_identity_preview_request) + print("The response of IdentityProfilesApi->generate_identity_preview:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IdentityProfilesApi->generate_identity_preview: %s\n" % e) /work-items/{id}/forward: post: operationId: forwardWorkItem @@ -48220,22 +67868,22 @@ paths: description: Success, but no data is returned. '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#forward-work-item + label: SDK_tools/sdk/powershell/v2025/methods/work-items#forward-work-item source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -48251,14 +67899,41 @@ paths: try { $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward - Invoke-V2024ForwardWorkItem -Id $Id -XSailPointExperimental $XSailPointExperimental -WorkItemForward $Result + Invoke-V2025ForwardWorkItem -Id $Id -XSailPointExperimental $XSailPointExperimental -WorkItemForward $Result # Below is a request that includes all optional parameters - # Invoke-V2024ForwardWorkItem -Id $Id -XSailPointExperimental $XSailPointExperimental -WorkItemForward $Result + # Invoke-V2025ForwardWorkItem -Id $Id -XSailPointExperimental $XSailPointExperimental -WorkItemForward $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ForwardWorkItem" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025ForwardWorkItem" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-items#forward-work-item + source: | + from sailpoint.v2025.api.work_items_api import WorkItemsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.work_item_forward import WorkItemForward + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + work_item_forward = '''{ + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + }''' # WorkItemForward | + try: + # Forward a Work Item + new_work_item_forward = WorkItemForward.from_json(work_item_forward) + WorkItemsApi(api_client).forward_work_item(id=id, x_sail_point_experimental=x_sail_point_experimental, work_item_forward=new_work_item_forward) + # Below is a request that includes all optional parameters + # WorkItemsApi(api_client).forward_work_item(id, x_sail_point_experimental, new_work_item_forward) + except Exception as e: + print("Exception when calling WorkItemsApi->forward_work_item: %s\n" % e) /accounts/search-attribute-config: post: operationId: createSearchAttributeConfig @@ -48266,10 +67941,13 @@ paths: - Search Attribute Configuration summary: Create Extended Search Attributes security: - - userAuth: [] + - userAuth: + - idn:account-config:create x-sailpoint-userLevels: - ORG_ADMIN - description: Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create and attribute promotion configuration in the Link ObjectConfig. + description: |- + Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. + >**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes' `applicationAttributes`.** requestBody: required: true content: @@ -48300,25 +67978,25 @@ paths: responses: '202': $ref: '#/paths/~1access-requests~1cancel/post/responses/202' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/202.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/202.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -48330,7 +68008,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/search-attribute-configuration#create-search-attribute-config + label: SDK_tools/sdk/powershell/v2025/methods/search-attribute-configuration#create-search-attribute-config source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $SearchAttributeConfig = @" @@ -48348,24 +68026,69 @@ paths: try { $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig - New-V2024SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental -SearchAttributeConfig $Result + New-V2025SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental -SearchAttributeConfig $Result # Below is a request that includes all optional parameters - # New-V2024SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental -SearchAttributeConfig $Result + # New-V2025SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental -SearchAttributeConfig $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SearchAttributeConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SearchAttributeConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/search-attribute-configuration#create-search-attribute-config + source: | + from sailpoint.v2025.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.search_attribute_config import SearchAttributeConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + search_attribute_config = '''{ + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + }''' # SearchAttributeConfig | + try: + # Create Extended Search Attributes + new_search_attribute_config = SearchAttributeConfig.from_json(search_attribute_config) + results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(x_sail_point_experimental=x_sail_point_experimental, search_attribute_config=new_search_attribute_config) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(x_sail_point_experimental, new_search_attribute_config) + print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->create_search_attribute_config: %s\n" % e) get: operationId: getSearchAttributeConfig tags: - Search Attribute Configuration summary: List Extended Search Attributes security: - - userAuth: [] + - userAuth: + - idn:account-config:read x-sailpoint-userLevels: - ORG_ADMIN - description: Get a list of attribute/application associates currently configured in Identity Security Cloud (ISC). + description: Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). + parameters: + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/2' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true responses: '200': description: List of attribute configurations in ISC. @@ -48375,45 +68098,66 @@ paths: type: array items: $ref: '#/paths/~1accounts~1search-attribute-config/post/requestBody/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/SearchAttributeConfig.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SearchAttributeConfig.yaml + '400': + $ref: '#/paths/~1access-profiles/get/responses/400' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/search-attribute-configuration#get-search-attribute-config + label: SDK_tools/sdk/powershell/v2025/methods/search-attribute-configuration#get-search-attribute-config source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $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) # List Extended Search Attributes try { - Get-V2024SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental + Get-V2025SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental + # Get-V2025SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SearchAttributeConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SearchAttributeConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/search-attribute-configuration#get-search-attribute-config + source: | + from sailpoint.v2025.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.search_attribute_config import SearchAttributeConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + try: + # List Extended Search Attributes + + results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(x_sail_point_experimental, limit, offset) + print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) /accounts/search-attribute-config/{name}: get: operationId: getSingleSearchAttributeConfig @@ -48447,31 +68191,29 @@ paths: content: application/json: schema: - type: array - items: - $ref: '#/paths/~1accounts~1search-attribute-config/post/requestBody/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/SearchAttributeConfig.yaml + $ref: '#/paths/~1accounts~1search-attribute-config/post/requestBody/content/application~1json/schema' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SearchAttributeConfig.yaml '204': $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/204.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/search-attribute-configuration#get-single-search-attribute-config + label: SDK_tools/sdk/powershell/v2025/methods/search-attribute-configuration#get-single-search-attribute-config source: | $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -48479,14 +68221,38 @@ paths: # Get Extended Search Attribute try { - Get-V2024SingleSearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental + Get-V2025SingleSearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024SingleSearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental + # Get-V2025SingleSearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SingleSearchAttributeConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SingleSearchAttributeConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/search-attribute-configuration#get-single-search-attribute-config + source: | + from sailpoint.v2025.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.search_attribute_config import SearchAttributeConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + name = 'newMailAttribute' # str | Name of the extended search attribute configuration to get. # str | Name of the extended search attribute configuration to get. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get Extended Search Attribute + + results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name=name, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name, x_sail_point_experimental) + print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e) delete: operationId: deleteSearchAttributeConfig tags: @@ -48516,25 +68282,25 @@ paths: responses: '204': $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/204.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/search-attribute-configuration#delete-search-attribute-config + label: SDK_tools/sdk/powershell/v2025/methods/search-attribute-configuration#delete-search-attribute-config source: | $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -48542,14 +68308,35 @@ paths: # Delete Extended Search Attribute try { - Remove-V2024SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental + Remove-V2025SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Remove-V2024SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental + # Remove-V2025SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SearchAttributeConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SearchAttributeConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/search-attribute-configuration#delete-search-attribute-config + source: | + from sailpoint.v2025.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + name = 'newMailAttribute' # str | Name of the extended search attribute configuration to delete. # str | Name of the extended search attribute configuration to delete. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Delete Extended Search Attribute + + SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name=name, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name, x_sail_point_experimental) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->delete_search_attribute_config: %s\n" % e) patch: operationId: patchSearchAttributeConfig tags: @@ -48586,7 +68373,7 @@ paths: type: array items: $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/JsonPatchOperation.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml example: - op: replace path: /name @@ -48606,28 +68393,28 @@ paths: application/json: schema: $ref: '#/paths/~1accounts~1search-attribute-config/post/requestBody/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/SearchAttributeConfig.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SearchAttributeConfig.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/search-attribute-configuration#patch-search-attribute-config + label: SDK_tools/sdk/powershell/v2025/methods/search-attribute-configuration#patch-search-attribute-config source: | $Name = "promotedMailAttribute" # String | Name of the search attribute configuration to patch. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -48642,14 +68429,40 @@ paths: try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + Update-V2025SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + # Update-V2025SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SearchAttributeConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SearchAttributeConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/search-attribute-configuration#patch-search-attribute-config + source: | + from sailpoint.v2025.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2025.models.search_attribute_config import SearchAttributeConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + name = 'promotedMailAttribute' # str | Name of the search attribute configuration to patch. # str | Name of the search attribute configuration to patch. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch_operation = '''[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}]''' # List[JsonPatchOperation] | + try: + # Update Extended Search Attribute + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name=name, x_sail_point_experimental=x_sail_point_experimental, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name, x_sail_point_experimental, new_json_patch_operation) + print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->patch_search_attribute_config: %s\n" % e) /access-model-metadata/attributes: get: summary: List Access Model Metadata Attributes @@ -48736,25 +68549,25 @@ paths: nullable: true items: $ref: '#/paths/~1access-model-metadata~1attributes~1%7Bkey%7D~1values/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/gov-attributes/AttributeValueDTO.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/gov-attributes/AttributeValueDTO.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-model-metadata#list-access-model-metadata-attribute + label: SDK_tools/sdk/powershell/v2025/methods/access-model-metadata#list-access-model-metadata-attribute source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Filters = "name eq "Privacy"" # 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: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) @@ -48762,14 +68575,38 @@ paths: # List Access Model Metadata Attributes try { - Get-V2024AccessModelMetadataAttribute -XSailPointExperimental $XSailPointExperimental + Get-V2025AccessModelMetadataAttribute -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024AccessModelMetadataAttribute -XSailPointExperimental $XSailPointExperimental -Filters $Filters + # Get-V2025AccessModelMetadataAttribute -XSailPointExperimental $XSailPointExperimental -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttribute" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessModelMetadataAttribute" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/access-model-metadata#list-access-model-metadata-attribute + source: | + from sailpoint.v2025.api.access_model_metadata_api import AccessModelMetadataApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.attribute_dto import AttributeDTO + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + filters = 'name eq \"Privacy\"' # 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: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (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: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) + try: + # List Access Model Metadata Attributes + + results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(x_sail_point_experimental, filters) + print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute: %s\n" % e) /access-model-metadata/attributes/{key}: get: summary: Get Access Model Metadata Attribute @@ -48804,25 +68641,25 @@ paths: application/json: schema: $ref: '#/paths/~1access-model-metadata~1attributes/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/gov-attributes/AttributeDTO.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/gov-attributes/AttributeDTO.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-model-metadata#get-access-model-metadata-attribute + label: SDK_tools/sdk/powershell/v2025/methods/access-model-metadata#get-access-model-metadata-attribute source: | $Key = "iscPrivacy" # String | Technical name of the Attribute. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -48830,14 +68667,38 @@ paths: # Get Access Model Metadata Attribute try { - Get-V2024AccessModelMetadataAttribute -Key $Key -XSailPointExperimental $XSailPointExperimental + Get-V2025AccessModelMetadataAttribute -Key $Key -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024AccessModelMetadataAttribute -Key $Key -XSailPointExperimental $XSailPointExperimental + # Get-V2025AccessModelMetadataAttribute -Key $Key -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttribute" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessModelMetadataAttribute" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/access-model-metadata#get-access-model-metadata-attribute + source: | + from sailpoint.v2025.api.access_model_metadata_api import AccessModelMetadataApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.attribute_dto import AttributeDTO + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get Access Model Metadata Attribute + + results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute(key=key, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute(key, x_sail_point_experimental) + print("The response of AccessModelMetadataApi->get_access_model_metadata_attribute:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccessModelMetadataApi->get_access_model_metadata_attribute: %s\n" % e) /access-model-metadata/attributes/{key}/values: get: summary: List Access Model Metadata Values @@ -48889,22 +68750,22 @@ paths: example: active '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-model-metadata#list-access-model-metadata-attribute-value + label: SDK_tools/sdk/powershell/v2025/methods/access-model-metadata#list-access-model-metadata-attribute-value source: | $Key = "iscPrivacy" # String | Technical name of the Attribute. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -48912,14 +68773,38 @@ paths: # List Access Model Metadata Values try { - Get-V2024AccessModelMetadataAttributeValue -Key $Key -XSailPointExperimental $XSailPointExperimental + Get-V2025AccessModelMetadataAttributeValue -Key $Key -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024AccessModelMetadataAttributeValue -Key $Key -XSailPointExperimental $XSailPointExperimental + # Get-V2025AccessModelMetadataAttributeValue -Key $Key -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttributeValue" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessModelMetadataAttributeValue" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/access-model-metadata#list-access-model-metadata-attribute-value + source: | + from sailpoint.v2025.api.access_model_metadata_api import AccessModelMetadataApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.attribute_value_dto import AttributeValueDTO + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # List Access Model Metadata Values + + results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key=key, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key, x_sail_point_experimental) + print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute_value:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute_value: %s\n" % e) /access-model-metadata/attributes/{key}/values/{value}: get: summary: Get Access Model Metadata Value @@ -48962,25 +68847,25 @@ paths: application/json: schema: $ref: '#/paths/~1access-model-metadata~1attributes~1%7Bkey%7D~1values/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/gov-attributes/AttributeValueDTO.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/gov-attributes/AttributeValueDTO.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-model-metadata#get-access-model-metadata-attribute-value + label: SDK_tools/sdk/powershell/v2025/methods/access-model-metadata#get-access-model-metadata-attribute-value source: | $Key = "iscPrivacy" # String | Technical name of the Attribute. $Value = "public" # String | Technical name of the Attribute value. @@ -48989,14 +68874,39 @@ paths: # Get Access Model Metadata Value try { - Get-V2024AccessModelMetadataAttributeValue -Key $Key -Value $Value -XSailPointExperimental $XSailPointExperimental + Get-V2025AccessModelMetadataAttributeValue -Key $Key -Value $Value -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024AccessModelMetadataAttributeValue -Key $Key -Value $Value -XSailPointExperimental $XSailPointExperimental + # Get-V2025AccessModelMetadataAttributeValue -Key $Key -Value $Value -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttributeValue" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessModelMetadataAttributeValue" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/access-model-metadata#get-access-model-metadata-attribute-value + source: | + from sailpoint.v2025.api.access_model_metadata_api import AccessModelMetadataApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.attribute_value_dto import AttributeValueDTO + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. + value = 'public' # str | Technical name of the Attribute value. # str | Technical name of the Attribute value. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get Access Model Metadata Value + + results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute_value(key=key, value=value, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute_value(key, value, x_sail_point_experimental) + print("The response of AccessModelMetadataApi->get_access_model_metadata_attribute_value:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccessModelMetadataApi->get_access_model_metadata_attribute_value: %s\n" % e) /access-profiles/bulk-update-requestable: post: operationId: updateAccessProfilesInBulk @@ -49093,13 +69003,13 @@ paths: description: Access Profile updated successfully. '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '412': description: Precondition Failed - Returned in response if API/Feature not enabled for an organization. content: @@ -49112,10 +69022,10 @@ paths: example: ' API/Feature not enabled for your organization.' '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:access-profile:manage @@ -49134,7 +69044,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-profiles#update-access-profiles-in-bulk + label: SDK_tools/sdk/powershell/v2025/methods/access-profiles#update-access-profiles-in-bulk source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $AccessProfileBulkUpdateRequestInner = @"[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]"@ @@ -49144,14 +69054,39 @@ paths: try { $Result = ConvertFrom-JsonToAccessProfileBulkUpdateRequestInner -Json $AccessProfileBulkUpdateRequestInner - Update-V2024AccessProfilesInBulk -XSailPointExperimental $XSailPointExperimental -AccessProfileBulkUpdateRequestInner $Result + Update-V2025AccessProfilesInBulk -XSailPointExperimental $XSailPointExperimental -AccessProfileBulkUpdateRequestInner $Result # Below is a request that includes all optional parameters - # Update-V2024AccessProfilesInBulk -XSailPointExperimental $XSailPointExperimental -AccessProfileBulkUpdateRequestInner $Result + # Update-V2025AccessProfilesInBulk -XSailPointExperimental $XSailPointExperimental -AccessProfileBulkUpdateRequestInner $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AccessProfilesInBulk" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AccessProfilesInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/access-profiles#update-access-profiles-in-bulk + source: | + from sailpoint.v2025.api.access_profiles_api import AccessProfilesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.access_profile_bulk_update_request_inner import AccessProfileBulkUpdateRequestInner + from sailpoint.v2025.models.access_profile_update_item import AccessProfileUpdateItem + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + access_profile_bulk_update_request_inner = '''[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]''' # List[AccessProfileBulkUpdateRequestInner] | + try: + # Update Access Profile(s) requestable field. + new_access_profile_bulk_update_request_inner = AccessProfileBulkUpdateRequestInner.from_json(access_profile_bulk_update_request_inner) + results = AccessProfilesApi(api_client).update_access_profiles_in_bulk(x_sail_point_experimental=x_sail_point_experimental, access_profile_bulk_update_request_inner=new_access_profile_bulk_update_request_inner) + # Below is a request that includes all optional parameters + # results = AccessProfilesApi(api_client).update_access_profiles_in_bulk(x_sail_point_experimental, new_access_profile_bulk_update_request_inner) + print("The response of AccessProfilesApi->update_access_profiles_in_bulk:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccessProfilesApi->update_access_profiles_in_bulk: %s\n" % e) /access-requests/close: post: operationId: closeAccessRequest @@ -49222,22 +69157,22 @@ paths: responses: '202': $ref: '#/paths/~1access-requests~1cancel/post/responses/202' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/202.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/202.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -49249,7 +69184,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-requests#close-access-request + label: SDK_tools/sdk/powershell/v2025/methods/access-requests#close-access-request source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $CloseAccessRequest = @" @@ -49265,19 +69200,53 @@ paths: try { $Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest - Close-V2024AccessRequest -XSailPointExperimental $XSailPointExperimental -CloseAccessRequest $Result + Close-V2025AccessRequest -XSailPointExperimental $XSailPointExperimental -CloseAccessRequest $Result # Below is a request that includes all optional parameters - # Close-V2024AccessRequest -XSailPointExperimental $XSailPointExperimental -CloseAccessRequest $Result + # Close-V2025AccessRequest -XSailPointExperimental $XSailPointExperimental -CloseAccessRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Close-V2024AccessRequest" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Close-V2025AccessRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/access-requests#close-access-request + source: | + from sailpoint.v2025.api.access_requests_api import AccessRequestsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.close_access_request import CloseAccessRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + close_access_request = '''{ + "executionStatus" : "Terminated", + "accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "completionStatus" : "Failure", + "message" : "The IdentityNow Administrator manually closed this request." + }''' # CloseAccessRequest | + try: + # Close Access Request + new_close_access_request = CloseAccessRequest.from_json(close_access_request) + results = AccessRequestsApi(api_client).close_access_request(x_sail_point_experimental=x_sail_point_experimental, close_access_request=new_close_access_request) + # Below is a request that includes all optional parameters + # results = AccessRequestsApi(api_client).close_access_request(x_sail_point_experimental, new_close_access_request) + print("The response of AccessRequestsApi->close_access_request:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccessRequestsApi->close_access_request: %s\n" % e) /ai-access-request-recommendations: get: operationId: getAccessRequestRecommendations tags: - IAI Access Request Recommendations + security: + - userAuth: + - iai:access-request-recommender:read + x-sailpoint-userLevels: + - Any summary: Identity Access Request Recommendations description: This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. parameters: @@ -49295,13 +69264,15 @@ paths: required: false schema: type: integer + format: int32 minimum: 0 maximum: 15 default: 15 + example: 15 - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - in: query name: include-translation-messages description: If *true* it will populate a list of translation messages in the response. @@ -49324,6 +69295,7 @@ paths: **access.type**: *eq, in* **access.description**: *co, eq, in* + required: false example: access.name co "admin" - in: query name: sorters @@ -49336,6 +69308,8 @@ paths: Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. + required: false + example: access.name - name: X-SailPoint-Experimental in: header description: Use this header to enable this experimental API. @@ -49428,43 +69402,73 @@ paths: - department '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations + label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $IdentityId = "2c91808570313110017040b06f344ec9" # String | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to "me") - $Limit = 56 # Int32 | Max number of results to return. (optional) (default to 15) + $Limit = 15 # Int32 | Max number of results to return. (optional) (default to 15) $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) $IncludeTranslationMessages = $false # Boolean | If *true* it will populate a list of translation messages in the response. (optional) (default to $false) $Filters = "access.name co "admin"" # 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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) - $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) + $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) # Identity Access Request Recommendations try { - Get-V2024AccessRequestRecommendations -XSailPointExperimental $XSailPointExperimental + Get-V2025AccessRequestRecommendations -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024AccessRequestRecommendations -XSailPointExperimental $XSailPointExperimental -IdentityId $IdentityId -Limit $Limit -Offset $Offset -Count $Count -IncludeTranslationMessages $IncludeTranslationMessages -Filters $Filters -Sorters $Sorters + # Get-V2025AccessRequestRecommendations -XSailPointExperimental $XSailPointExperimental -IdentityId $IdentityId -Limit $Limit -Offset $Offset -Count $Count -IncludeTranslationMessages $IncludeTranslationMessages -Filters $Filters -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendations" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestRecommendations" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations + source: | + from sailpoint.v2025.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.access_request_recommendation_item_detail import AccessRequestRecommendationItemDetail + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + identity_id = 'me' # str | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to 'me') # str | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to 'me') + limit = 15 # int | Max number of results to return. (optional) (default to 15) # int | Max number of results to return. (optional) (default to 15) + 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) + include_translation_messages = False # bool | If *true* it will populate a list of translation messages in the response. (optional) (default to False) # bool | If *true* it will populate a list of translation messages in the response. (optional) (default to False) + filters = 'access.name co \"admin\"' # 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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) + sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) + try: + # Identity Access Request Recommendations + + results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations(x_sail_point_experimental, identity_id, limit, offset, count, include_translation_messages, filters, sorters) + print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations: %s\n" % e) /ai-access-request-recommendations/config: get: operationId: getAccessRequestRecommendationsConfig @@ -49524,36 +69528,59 @@ paths: - scoreThreshold '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-config + label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations-config source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Get Access Request Recommendations config try { - Get-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental + Get-V2025AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental + # Get-V2025AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestRecommendationsConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations-config + source: | + from sailpoint.v2025.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.access_request_recommendation_config_dto import AccessRequestRecommendationConfigDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get Access Request Recommendations config + + results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_config(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_config(x_sail_point_experimental) + print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_config: %s\n" % e) put: operationId: setAccessRequestRecommendationsConfig tags: @@ -49572,7 +69599,7 @@ paths: application/json: schema: $ref: '#/paths/~1ai-access-request-recommendations~1config/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/AccessRequestRecommendationConfigDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationConfigDto.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -49589,25 +69616,25 @@ paths: application/json: schema: $ref: '#/paths/~1ai-access-request-recommendations~1config/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/AccessRequestRecommendationConfigDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationConfigDto.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#set-access-request-recommendations-config + label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#set-access-request-recommendations-config source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $AccessRequestRecommendationConfigDto = @" @@ -49625,20 +69652,56 @@ paths: try { $Result = ConvertFrom-JsonToAccessRequestRecommendationConfigDto -Json $AccessRequestRecommendationConfigDto - Set-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationConfigDto $Result + Set-V2025AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationConfigDto $Result # Below is a request that includes all optional parameters - # Set-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationConfigDto $Result + # Set-V2025AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationConfigDto $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024AccessRequestRecommendationsConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025AccessRequestRecommendationsConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-access-request-recommendations#set-access-request-recommendations-config + source: | + from sailpoint.v2025.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.access_request_recommendation_config_dto import AccessRequestRecommendationConfigDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + access_request_recommendation_config_dto = '''{ + "scoreThreshold" : 0.5, + "startDateAttribute" : "startDate", + "restrictionAttribute" : "location", + "moverAttribute" : "isMover", + "joinerAttribute" : "isJoiner", + "useRestrictionAttribute" : true + }''' # AccessRequestRecommendationConfigDto | The desired configurations for Access Request Recommender for the tenant. + try: + # Update Access Request Recommendations config + new_access_request_recommendation_config_dto = AccessRequestRecommendationConfigDto.from_json(access_request_recommendation_config_dto) + results = IAIAccessRequestRecommendationsApi(api_client).set_access_request_recommendations_config(x_sail_point_experimental=x_sail_point_experimental, access_request_recommendation_config_dto=new_access_request_recommendation_config_dto) + # Below is a request that includes all optional parameters + # results = IAIAccessRequestRecommendationsApi(api_client).set_access_request_recommendations_config(x_sail_point_experimental, new_access_request_recommendation_config_dto) + print("The response of IAIAccessRequestRecommendationsApi->set_access_request_recommendations_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->set_access_request_recommendations_config: %s\n" % e) /ai-access-request-recommendations/ignored-items: post: operationId: addAccessRequestRecommendationsIgnoredItem tags: - IAI Access Request Recommendations - summary: Notification of Ignored Access Request Recommendations + security: + - userAuth: + - iai:access-request-recommender:manage + x-sailpoint-userLevels: + - Any + summary: Ignore Access Request Recommendation description: This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations. requestBody: description: The recommended access item to ignore for an identity. @@ -49663,7 +69726,7 @@ paths: example: 2c9180835d2e5168015d32f890ca1581 type: $ref: '#/paths/~1ai-access-request-recommendations/get/responses/200/content/application~1json/schema/items/properties/access/properties/type' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/AccessRequestRecommendationItemType.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationItemType.yaml required: - identityId - access @@ -49682,26 +69745,26 @@ paths: example: 2c91808570313110017040b06f344ec9 access: $ref: '#/paths/~1ai-access-request-recommendations~1ignored-items/post/requestBody/content/application~1json/schema/properties/access' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/AccessRequestRecommendationItem.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationItem.yaml timestamp: type: string format: date-time example: '2017-07-11T18:45:37.098Z' '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -49713,7 +69776,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-ignored-item + label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#add-access-request-recommendations-ignored-item source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $AccessRequestRecommendationActionItemDto = @" @@ -49726,31 +69789,67 @@ paths: } "@ - # Notification of Ignored Access Request Recommendations + # Ignore Access Request Recommendation try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-V2024AccessRequestRecommendationsIgnoredItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result + Add-V2025AccessRequestRecommendationsIgnoredItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result # Below is a request that includes all optional parameters - # Add-V2024AccessRequestRecommendationsIgnoredItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result + # Add-V2025AccessRequestRecommendationsIgnoredItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsIgnoredItem" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2025AccessRequestRecommendationsIgnoredItem" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-access-request-recommendations#add-access-request-recommendations-ignored-item + source: | + from sailpoint.v2025.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.access_request_recommendation_action_item_dto import AccessRequestRecommendationActionItemDto + from sailpoint.v2025.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + access_request_recommendation_action_item_dto = '''{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + }''' # AccessRequestRecommendationActionItemDto | The recommended access item to ignore for an identity. + try: + # Ignore Access Request Recommendation + new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto.from_json(access_request_recommendation_action_item_dto) + results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_ignored_item(x_sail_point_experimental=x_sail_point_experimental, access_request_recommendation_action_item_dto=new_access_request_recommendation_action_item_dto) + # Below is a request that includes all optional parameters + # results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_ignored_item(x_sail_point_experimental, new_access_request_recommendation_action_item_dto) + print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_ignored_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_ignored_item: %s\n" % e) get: operationId: getAccessRequestRecommendationsIgnoredItems tags: - IAI Access Request Recommendations - summary: List of Ignored Access Request Recommendations + security: + - userAuth: + - iai:access-request-recommender:manage + x-sailpoint-userLevels: + - Any + summary: List Ignored Access Request Recommendations description: This API returns the list of ignored access request recommendations. parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - in: query name: filters schema: @@ -49765,6 +69864,7 @@ paths: **access.type**: *eq, in* **identityId**: *eq, in* + required: false example: identityId eq "2c9180846b0a0583016b299f210c1314" - in: query name: sorters @@ -49775,6 +69875,7 @@ paths: Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** + required: false example: access.id - name: X-SailPoint-Experimental in: header @@ -49793,25 +69894,25 @@ paths: type: array items: $ref: '#/paths/~1ai-access-request-recommendations~1ignored-items/post/responses/201/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/AccessRequestRecommendationActionItemResponseDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationActionItemResponseDto.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-ignored-items + label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations-ignored-items source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $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) @@ -49820,23 +69921,56 @@ paths: $Filters = "identityId eq "2c9180846b0a0583016b299f210c1314"" # 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) - # List of Ignored Access Request Recommendations + # List Ignored Access Request Recommendations try { - Get-V2024AccessRequestRecommendationsIgnoredItems -XSailPointExperimental $XSailPointExperimental + Get-V2025AccessRequestRecommendationsIgnoredItems -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024AccessRequestRecommendationsIgnoredItems -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + # Get-V2025AccessRequestRecommendationsIgnoredItems -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsIgnoredItems" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestRecommendationsIgnoredItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations-ignored-items + source: | + from sailpoint.v2025.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + filters = 'identityId eq \"2c9180846b0a0583016b299f210c1314\"' # 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + sorters = 'access.id' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) + try: + # List Ignored Access Request Recommendations + + results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_ignored_items(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_ignored_items(x_sail_point_experimental, limit, offset, count, filters, sorters) + print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items: %s\n" % e) /ai-access-request-recommendations/requested-items: post: operationId: addAccessRequestRecommendationsRequestedItem tags: - IAI Access Request Recommendations - summary: Notification of Requested Access Request Recommendations + security: + - userAuth: + - iai:access-request-recommender:manage + x-sailpoint-userLevels: + - Any + summary: Accept Access Request Recommendation description: This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations. requestBody: description: The recommended access item that was requested for an identity. @@ -49845,7 +69979,7 @@ paths: application/json: schema: $ref: '#/paths/~1ai-access-request-recommendations~1ignored-items/post/requestBody/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/AccessRequestRecommendationActionItemDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationActionItemDto.yaml responses: '201': description: Notification successfully acknowledged. @@ -49853,22 +69987,22 @@ paths: application/json: schema: $ref: '#/paths/~1ai-access-request-recommendations~1ignored-items/post/responses/201/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/AccessRequestRecommendationActionItemResponseDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationActionItemResponseDto.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -49880,7 +70014,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-requested-item + label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#add-access-request-recommendations-requested-item source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $AccessRequestRecommendationActionItemDto = @" @@ -49893,31 +70027,67 @@ paths: } "@ - # Notification of Requested Access Request Recommendations + # Accept Access Request Recommendation try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-V2024AccessRequestRecommendationsRequestedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result + Add-V2025AccessRequestRecommendationsRequestedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result # Below is a request that includes all optional parameters - # Add-V2024AccessRequestRecommendationsRequestedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result + # Add-V2025AccessRequestRecommendationsRequestedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsRequestedItem" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2025AccessRequestRecommendationsRequestedItem" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-access-request-recommendations#add-access-request-recommendations-requested-item + source: | + from sailpoint.v2025.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.access_request_recommendation_action_item_dto import AccessRequestRecommendationActionItemDto + from sailpoint.v2025.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + access_request_recommendation_action_item_dto = '''{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + }''' # AccessRequestRecommendationActionItemDto | The recommended access item that was requested for an identity. + try: + # Accept Access Request Recommendation + new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto.from_json(access_request_recommendation_action_item_dto) + results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_requested_item(x_sail_point_experimental=x_sail_point_experimental, access_request_recommendation_action_item_dto=new_access_request_recommendation_action_item_dto) + # Below is a request that includes all optional parameters + # results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_requested_item(x_sail_point_experimental, new_access_request_recommendation_action_item_dto) + print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_requested_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_requested_item: %s\n" % e) get: operationId: getAccessRequestRecommendationsRequestedItems tags: - IAI Access Request Recommendations - summary: List of Requested Access Request Recommendations + security: + - userAuth: + - iai:access-request-recommender:manage + x-sailpoint-userLevels: + - Any + summary: List Accepted Access Request Recommendations description: This API returns a list of requested access request recommendations. parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - in: query name: filters schema: @@ -49932,6 +70102,7 @@ paths: **access.type**: *eq, in* **identityId**: *eq, in* + required: false example: access.id eq "2c9180846b0a0583016b299f210c1314" - in: query name: sorters @@ -49942,6 +70113,8 @@ paths: Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** + required: false + example: access.id - name: X-SailPoint-Experimental in: header description: Use this header to enable this experimental API. @@ -49959,50 +70132,83 @@ paths: type: array items: $ref: '#/paths/~1ai-access-request-recommendations~1ignored-items/post/responses/201/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/AccessRequestRecommendationActionItemResponseDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationActionItemResponseDto.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-requested-items + label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations-requested-items source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $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) $Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) - $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) + $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) - # List of Requested Access Request Recommendations + # List Accepted Access Request Recommendations try { - Get-V2024AccessRequestRecommendationsRequestedItems -XSailPointExperimental $XSailPointExperimental + Get-V2025AccessRequestRecommendationsRequestedItems -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024AccessRequestRecommendationsRequestedItems -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + # Get-V2025AccessRequestRecommendationsRequestedItems -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsRequestedItems" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestRecommendationsRequestedItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations-requested-items + source: | + from sailpoint.v2025.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + filters = 'access.id eq \"2c9180846b0a0583016b299f210c1314\"' # 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + sorters = 'access.id' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) + try: + # List Accepted Access Request Recommendations + + results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_requested_items(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_requested_items(x_sail_point_experimental, limit, offset, count, filters, sorters) + print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items: %s\n" % e) /ai-access-request-recommendations/viewed-items: post: operationId: addAccessRequestRecommendationsViewedItem tags: - IAI Access Request Recommendations - summary: Notification of Viewed Access Request Recommendations + security: + - userAuth: + - iai:access-request-recommender:manage + x-sailpoint-userLevels: + - Any + summary: Mark Viewed Access Request Recommendations description: This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. requestBody: description: The recommended access that was viewed for an identity. @@ -50011,7 +70217,7 @@ paths: application/json: schema: $ref: '#/paths/~1ai-access-request-recommendations~1ignored-items/post/requestBody/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/AccessRequestRecommendationActionItemDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationActionItemDto.yaml responses: '201': description: Recommendation successfully stored as viewed. @@ -50019,22 +70225,22 @@ paths: application/json: schema: $ref: '#/paths/~1ai-access-request-recommendations~1ignored-items/post/responses/201/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/AccessRequestRecommendationActionItemResponseDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationActionItemResponseDto.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -50046,7 +70252,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-item + label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-item source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $AccessRequestRecommendationActionItemDto = @" @@ -50059,31 +70265,67 @@ paths: } "@ - # Notification of Viewed Access Request Recommendations + # Mark Viewed Access Request Recommendations try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-V2024AccessRequestRecommendationsViewedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result + Add-V2025AccessRequestRecommendationsViewedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result # Below is a request that includes all optional parameters - # Add-V2024AccessRequestRecommendationsViewedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result + # Add-V2025AccessRequestRecommendationsViewedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsViewedItem" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2025AccessRequestRecommendationsViewedItem" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-item + source: | + from sailpoint.v2025.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.access_request_recommendation_action_item_dto import AccessRequestRecommendationActionItemDto + from sailpoint.v2025.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + access_request_recommendation_action_item_dto = '''{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + }''' # AccessRequestRecommendationActionItemDto | The recommended access that was viewed for an identity. + try: + # Mark Viewed Access Request Recommendations + new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto.from_json(access_request_recommendation_action_item_dto) + results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_item(x_sail_point_experimental=x_sail_point_experimental, access_request_recommendation_action_item_dto=new_access_request_recommendation_action_item_dto) + # Below is a request that includes all optional parameters + # results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_item(x_sail_point_experimental, new_access_request_recommendation_action_item_dto) + print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_item: %s\n" % e) get: operationId: getAccessRequestRecommendationsViewedItems tags: - IAI Access Request Recommendations - summary: List of Viewed Access Request Recommendations + security: + - userAuth: + - iai:access-request-recommender:read + x-sailpoint-userLevels: + - Any + summary: List Viewed Access Request Recommendations description: This API returns the list of viewed access request recommendations. parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - in: query name: filters schema: @@ -50098,6 +70340,7 @@ paths: **access.type**: *eq, in* **identityId**: *eq, in* + required: false example: access.id eq "2c9180846b0a0583016b299f210c1314" - in: query name: sorters @@ -50108,6 +70351,8 @@ paths: Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** + required: false + example: access.id - name: X-SailPoint-Experimental in: header description: Use this header to enable this experimental API. @@ -50125,50 +70370,83 @@ paths: type: array items: $ref: '#/paths/~1ai-access-request-recommendations~1ignored-items/post/responses/201/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/AccessRequestRecommendationActionItemResponseDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationActionItemResponseDto.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-viewed-items + label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations-viewed-items source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $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) $Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) - $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) + $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) - # List of Viewed Access Request Recommendations + # List Viewed Access Request Recommendations try { - Get-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental + Get-V2025AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + # Get-V2025AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsViewedItems" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestRecommendationsViewedItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-access-request-recommendations#get-access-request-recommendations-viewed-items + source: | + from sailpoint.v2025.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + filters = 'access.id eq \"2c9180846b0a0583016b299f210c1314\"' # 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + sorters = 'access.id' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) + try: + # List Viewed Access Request Recommendations + + results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_viewed_items(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_viewed_items(x_sail_point_experimental, limit, offset, count, filters, sorters) + print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items: %s\n" % e) /ai-access-request-recommendations/viewed-items/bulk-create: post: operationId: addAccessRequestRecommendationsViewedItems tags: - IAI Access Request Recommendations - summary: Notification of Viewed Access Request Recommendations in Bulk + security: + - userAuth: + - iai:access-request-recommender:manage + x-sailpoint-userLevels: + - Any + summary: Bulk Mark Viewed Access Request Recommendations description: This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. requestBody: description: The recommended access items that were viewed for an identity. @@ -50179,7 +70457,7 @@ paths: type: array items: $ref: '#/paths/~1ai-access-request-recommendations~1ignored-items/post/requestBody/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/AccessRequestRecommendationActionItemDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationActionItemDto.yaml responses: '201': description: Recommendations successfully stored as viewed. @@ -50189,22 +70467,22 @@ paths: type: array items: $ref: '#/paths/~1ai-access-request-recommendations~1ignored-items/post/responses/201/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/AccessRequestRecommendationActionItemResponseDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessRequestRecommendationActionItemResponseDto.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -50216,7 +70494,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-items + label: SDK_tools/sdk/powershell/v2025/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-items source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $AccessRequestRecommendationActionItemDto = @"{ @@ -50228,18 +70506,43 @@ paths: }"@ - # Notification of Viewed Access Request Recommendations in Bulk + # Bulk Mark Viewed Access Request Recommendations try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result + Add-V2025AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result # Below is a request that includes all optional parameters - # Add-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result + # Add-V2025AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsViewedItems" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2025AccessRequestRecommendationsViewedItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-items + source: | + from sailpoint.v2025.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.access_request_recommendation_action_item_dto import AccessRequestRecommendationActionItemDto + from sailpoint.v2025.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + access_request_recommendation_action_item_dto = '''[sailpoint.v2025.AccessRequestRecommendationActionItemDto()]''' # List[AccessRequestRecommendationActionItemDto] | The recommended access items that were viewed for an identity. + try: + # Bulk Mark Viewed Access Request Recommendations + new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto.from_json(access_request_recommendation_action_item_dto) + results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_items(x_sail_point_experimental=x_sail_point_experimental, access_request_recommendation_action_item_dto=new_access_request_recommendation_action_item_dto) + # Below is a request that includes all optional parameters + # results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_items(x_sail_point_experimental, new_access_request_recommendation_action_item_dto) + print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items: %s\n" % e) /accounts/{id}/remove: post: operationId: deleteAccountAsync @@ -50277,32 +70580,32 @@ paths: application/json: schema: $ref: '#/paths/~1roles~1bulk-delete/post/responses/202/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/TaskResultDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TaskResultDto.yaml example: type: TASK_RESULT id: 464ae7bf791e49fdb74606a2e4a89635 name: null '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - - idn:account:manage + - idn:accounts:manage x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/accounts#delete-account-async + label: SDK_tools/sdk/powershell/v2025/methods/accounts#delete-account-async source: | $Id = "c350d6aa4f104c61b062cb632421ad10" # String | The account id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -50310,14 +70613,38 @@ paths: # Remove Account try { - Remove-V2024AccountAsync -Id $Id -XSailPointExperimental $XSailPointExperimental + Remove-V2025AccountAsync -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Remove-V2024AccountAsync -Id $Id -XSailPointExperimental $XSailPointExperimental + # Remove-V2025AccountAsync -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccountAsync" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025AccountAsync" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/accounts#delete-account-async + source: | + from sailpoint.v2025.api.accounts_api import AccountsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.task_result_dto import TaskResultDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = 'c350d6aa4f104c61b062cb632421ad10' # str | The account id # str | The account id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Remove Account + + results = AccountsApi(api_client).delete_account_async(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).delete_account_async(id, x_sail_point_experimental) + print("The response of AccountsApi->delete_account_async:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountsApi->delete_account_async: %s\n" % e) /identities-accounts/{id}/enable: post: operationId: enableAccountForIdentity @@ -50351,28 +70678,28 @@ paths: responses: '202': $ref: '#/paths/~1access-requests~1cancel/post/responses/202' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/202.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/202.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/accounts#enable-account-for-identity + label: SDK_tools/sdk/powershell/v2025/methods/accounts#enable-account-for-identity source: | $Id = "2c91808384203c2d018437e631158309" # String | The identity id. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -50380,14 +70707,37 @@ paths: # Enable IDN Account for Identity try { - Enable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + Enable-V2025AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Enable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + # Enable-V2025AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024AccountForIdentity" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2025AccountForIdentity" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/accounts#enable-account-for-identity + source: | + from sailpoint.v2025.api.accounts_api import AccountsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Enable IDN Account for Identity + + results = AccountsApi(api_client).enable_account_for_identity(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).enable_account_for_identity(id, x_sail_point_experimental) + print("The response of AccountsApi->enable_account_for_identity:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountsApi->enable_account_for_identity: %s\n" % e) /identities-accounts/{id}/disable: post: operationId: disableAccountForIdentity @@ -50421,28 +70771,28 @@ paths: responses: '202': $ref: '#/paths/~1access-requests~1cancel/post/responses/202' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/202.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/202.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/accounts#disable-account-for-identity + label: SDK_tools/sdk/powershell/v2025/methods/accounts#disable-account-for-identity source: | $Id = "2c91808384203c2d018437e631158309" # String | The identity id. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -50450,14 +70800,37 @@ paths: # Disable IDN Account for Identity try { - Disable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + Disable-V2025AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Disable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + # Disable-V2025AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024AccountForIdentity" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2025AccountForIdentity" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/accounts#disable-account-for-identity + source: | + from sailpoint.v2025.api.accounts_api import AccountsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Disable IDN Account for Identity + + results = AccountsApi(api_client).disable_account_for_identity(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).disable_account_for_identity(id, x_sail_point_experimental) + print("The response of AccountsApi->disable_account_for_identity:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountsApi->disable_account_for_identity: %s\n" % e) /identities-accounts/enable: post: operationId: enableAccountsForIdentities @@ -50519,19 +70892,19 @@ paths: message: null '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -50543,7 +70916,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/accounts#enable-accounts-for-identities + label: SDK_tools/sdk/powershell/v2025/methods/accounts#enable-accounts-for-identities source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $IdentitiesAccountsBulkRequest = @" @@ -50556,14 +70929,41 @@ paths: try { $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest - Enable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result + Enable-V2025AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result # Below is a request that includes all optional parameters - # Enable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result + # Enable-V2025AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024AccountsForIdentities" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2025AccountsForIdentities" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/accounts#enable-accounts-for-identities + source: | + from sailpoint.v2025.api.accounts_api import AccountsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.bulk_identities_accounts_response import BulkIdentitiesAccountsResponse + from sailpoint.v2025.models.identities_accounts_bulk_request import IdentitiesAccountsBulkRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + identities_accounts_bulk_request = '''{ + "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] + }''' # IdentitiesAccountsBulkRequest | + try: + # Enable IDN Accounts for Identities + new_identities_accounts_bulk_request = IdentitiesAccountsBulkRequest.from_json(identities_accounts_bulk_request) + results = AccountsApi(api_client).enable_accounts_for_identities(x_sail_point_experimental=x_sail_point_experimental, identities_accounts_bulk_request=new_identities_accounts_bulk_request) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).enable_accounts_for_identities(x_sail_point_experimental, new_identities_accounts_bulk_request) + print("The response of AccountsApi->enable_accounts_for_identities:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountsApi->enable_accounts_for_identities: %s\n" % e) /identities-accounts/disable: post: operationId: disableAccountsForIdentities @@ -50583,7 +70983,7 @@ paths: application/json: schema: $ref: '#/paths/~1identities-accounts~1enable/post/requestBody/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/IdentitiesAccountsBulkRequest.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/IdentitiesAccountsBulkRequest.yaml responses: '207': description: Bulk response details. @@ -50593,7 +70993,7 @@ paths: type: array items: $ref: '#/paths/~1identities-accounts~1enable/post/responses/207/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/BulkIdentitiesAccountsResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BulkIdentitiesAccountsResponse.yaml example: - id: 2c9180858082150f0180893dbaf553fe statusCode: 404 @@ -50603,19 +71003,19 @@ paths: message: null '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -50627,7 +71027,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/accounts#disable-accounts-for-identities + label: SDK_tools/sdk/powershell/v2025/methods/accounts#disable-accounts-for-identities source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $IdentitiesAccountsBulkRequest = @" @@ -50640,14 +71040,41 @@ paths: try { $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest - Disable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result + Disable-V2025AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result # Below is a request that includes all optional parameters - # Disable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result + # Disable-V2025AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024AccountsForIdentities" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2025AccountsForIdentities" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/accounts#disable-accounts-for-identities + source: | + from sailpoint.v2025.api.accounts_api import AccountsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.bulk_identities_accounts_response import BulkIdentitiesAccountsResponse + from sailpoint.v2025.models.identities_accounts_bulk_request import IdentitiesAccountsBulkRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + identities_accounts_bulk_request = '''{ + "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] + }''' # IdentitiesAccountsBulkRequest | + try: + # Disable IDN Accounts for Identities + new_identities_accounts_bulk_request = IdentitiesAccountsBulkRequest.from_json(identities_accounts_bulk_request) + results = AccountsApi(api_client).disable_accounts_for_identities(x_sail_point_experimental=x_sail_point_experimental, identities_accounts_bulk_request=new_identities_accounts_bulk_request) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).disable_accounts_for_identities(x_sail_point_experimental, new_identities_accounts_bulk_request) + print("The response of AccountsApi->disable_accounts_for_identities:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountsApi->disable_accounts_for_identities: %s\n" % e) /account-aggregations/{id}/status: get: operationId: getAccountAggregationStatus @@ -50697,6 +71124,7 @@ paths: start: type: string format: date-time + nullable: true example: '2021-01-31T14:30:05.104Z' description: When the aggregation started. status: @@ -50708,6 +71136,7 @@ paths: - CANCELLED - RETRIED - TERMINATED + - NOT_FOUND example: ACCOUNTS_COLLECTED description: | STARTED - Aggregation started, but source account iteration has not completed. @@ -50731,22 +71160,22 @@ paths: description: The number of *NEW, CHANGED and DELETED* accounts that have been processed so far. This reflects the number of accounts that have been processed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/account-aggregations#get-account-aggregation-status + label: SDK_tools/sdk/powershell/v2025/methods/account-aggregations#get-account-aggregation-status source: | $Id = "2c91808477a6b0c60177a81146b8110b" # String | The account aggregation id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -50754,20 +71183,44 @@ paths: # In-progress Account Aggregation status try { - Get-V2024AccountAggregationStatus -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2025AccountAggregationStatus -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024AccountAggregationStatus -Id $Id -XSailPointExperimental $XSailPointExperimental + # Get-V2025AccountAggregationStatus -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountAggregationStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccountAggregationStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/account-aggregations#get-account-aggregation-status + source: | + from sailpoint.v2025.api.account_aggregations_api import AccountAggregationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.account_aggregation_status import AccountAggregationStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '2c91808477a6b0c60177a81146b8110b' # str | The account aggregation id # str | The account aggregation id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # In-progress Account Aggregation status + + results = AccountAggregationsApi(api_client).get_account_aggregation_status(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = AccountAggregationsApi(api_client).get_account_aggregation_status(id, x_sail_point_experimental) + print("The response of AccountAggregationsApi->get_account_aggregation_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountAggregationsApi->get_account_aggregation_status: %s\n" % e) /auth-profiles: get: operationId: getProfileConfigList tags: - Auth Profile - summary: Get list of Auth Profiles. + summary: Get list of Auth Profiles description: This API returns a list of auth profiles. security: - userAuth: @@ -50778,31 +71231,33 @@ paths: content: application/json: schema: - type: object - properties: - tenant: - type: string - description: Tenant name. - example: test-tenant - id: - type: string - description: Identity ID. - example: 2c91808458ae7a4f0158b1bbf8af0628 + type: array + items: + type: object + properties: + tenant: + type: string + description: Tenant name. + example: test-tenant + id: + type: string + description: Identity ID. + example: 2c91808458ae7a4f0158b1bbf8af0628 '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -50814,27 +71269,50 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/auth-profile#get-profile-config-list + label: SDK_tools/sdk/powershell/v2025/methods/auth-profile#get-profile-config-list source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get list of Auth Profiles. + # Get list of Auth Profiles try { - Get-V2024ProfileConfigList -XSailPointExperimental $XSailPointExperimental + Get-V2025ProfileConfigList -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024ProfileConfigList -XSailPointExperimental $XSailPointExperimental + # Get-V2025ProfileConfigList -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProfileConfigList" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ProfileConfigList" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/auth-profile#get-profile-config-list + source: | + from sailpoint.v2025.api.auth_profile_api import AuthProfileApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.auth_profile_summary import AuthProfileSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get list of Auth Profiles + + results = AuthProfileApi(api_client).get_profile_config_list(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = AuthProfileApi(api_client).get_profile_config_list(x_sail_point_experimental) + print("The response of AuthProfileApi->get_profile_config_list:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AuthProfileApi->get_profile_config_list: %s\n" % e) /auth-profiles/{id}: get: operationId: getProfileConfig tags: - Auth Profile - summary: Get Auth Profile. + summary: Get Auth Profile description: This API returns auth profile information. security: - userAuth: @@ -50863,10 +71341,12 @@ paths: example: true applicationId: type: string + nullable: true description: Application ID. example: 2c91808458ae7a4f0158b1bbf8af0628 applicationName: type: string + nullable: true description: Application name. example: EndToEnd-Source type: @@ -50885,22 +71365,22 @@ paths: example: true '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -50920,22 +71400,46 @@ paths: example: 2c91808a7813090a017814121919ecca x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/auth-profile#get-profile-config + label: SDK_tools/sdk/powershell/v2025/methods/auth-profile#get-profile-config source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to patch. - # Get Auth Profile. + # Get Auth Profile try { - Get-V2024ProfileConfig -XSailPointExperimental $XSailPointExperimental -Id $Id + Get-V2025ProfileConfig -XSailPointExperimental $XSailPointExperimental -Id $Id # Below is a request that includes all optional parameters - # Get-V2024ProfileConfig -XSailPointExperimental $XSailPointExperimental -Id $Id + # Get-V2025ProfileConfig -XSailPointExperimental $XSailPointExperimental -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProfileConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ProfileConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/auth-profile#get-profile-config + source: | + from sailpoint.v2025.api.auth_profile_api import AuthProfileApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.auth_profile import AuthProfile + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + id = '2c91808a7813090a017814121919ecca' # str | ID of the Auth Profile to patch. # str | ID of the Auth Profile to patch. + try: + # Get Auth Profile + + results = AuthProfileApi(api_client).get_profile_config(x_sail_point_experimental=x_sail_point_experimental, id=id) + # Below is a request that includes all optional parameters + # results = AuthProfileApi(api_client).get_profile_config(x_sail_point_experimental, id) + print("The response of AuthProfileApi->get_profile_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AuthProfileApi->get_profile_config: %s\n" % e) patch: operationId: patchProfileConfig tags: @@ -50968,7 +71472,7 @@ paths: type: array items: $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/JsonPatchOperation.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml required: true responses: '200': @@ -50977,28 +71481,28 @@ paths: application/json: schema: $ref: '#/paths/~1auth-profiles~1%7Bid%7D/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/AuthProfile.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AuthProfile.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - sp:auth-profile:update x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/auth-profile#patch-profile-config + label: SDK_tools/sdk/powershell/v2025/methods/auth-profile#patch-profile-config source: | $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to patch. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -51013,671 +71517,40 @@ paths: try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024ProfileConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + Update-V2025ProfileConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024ProfileConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + # Update-V2025ProfileConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProfileConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ProfileConfig" Write-Host $_.ErrorDetails } - /connector-rules: - get: - tags: - - Connector Rule Management - operationId: getConnectorRuleList - summary: List Connector Rules - description: List existing connector rules. - responses: - '200': - description: List of connector rules. - content: - application/json: - schema: - type: array - items: - description: ConnectorRuleResponse - allOf: - - $ref: '#/paths/~1connector-rules/post/requestBody/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ConnectorRuleCreateRequest.yaml - - type: object - nullable: true - required: - - id - - created - properties: - id: - type: string - description: the ID of the rule - example: 8113d48c0b914f17b4c6072d4dcb9dfe - created: - type: string - description: an ISO 8601 UTC timestamp when this rule was created - example: 021-07-22T15:59:23Z - modified: - type: string - nullable: true - description: an ISO 8601 UTC timestamp when this rule was last modified - example: 021-07-22T15:59:23Z - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml - security: - - userAuth: - - idn:rule-management-connector:read - - idn:rule-management-connector:manage - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit50.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/connector-rule-management#get-connector-rule-list + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/auth-profile#patch-profile-config source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $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) + from sailpoint.v2025.api.auth_profile_api import AuthProfileApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.auth_profile import AuthProfile + from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation + from sailpoint.configuration import Configuration + configuration = Configuration() - # List Connector Rules + configuration.experimental = true - try { - Get-V2024ConnectorRuleList -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024ConnectorRuleList -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorRuleList" - Write-Host $_.ErrorDetails - } - post: - tags: - - Connector Rule Management - operationId: createConnectorRule - summary: Create Connector Rule - description: Create a connector rule from the available types. - requestBody: - required: true - description: Connector rule to create. - content: - application/json: - schema: - description: ConnectorRuleCreateRequest - type: object - required: - - name - - type - - sourceCode - properties: - name: - type: string - description: the name of the rule - example: WebServiceBeforeOperationRule - minLength: 1 - maxLength: 128 - description: - type: string - description: a description of the rule's purpose - example: This rule does that - type: - type: string - enum: - - BuildMap - - ConnectorAfterCreate - - ConnectorAfterDelete - - ConnectorAfterModify - - ConnectorBeforeCreate - - ConnectorBeforeDelete - - ConnectorBeforeModify - - JDBCBuildMap - - JDBCOperationProvisioning - - JDBCProvision - - PeopleSoftHRMSBuildMap - - PeopleSoftHRMSOperationProvisioning - - PeopleSoftHRMSProvision - - RACFPermissionCustomization - - SAPBuildMap - - SapHrManagerRule - - SapHrOperationProvisioning - - SapHrProvision - - SuccessFactorsOperationProvisioning - - WebServiceAfterOperationRule - - WebServiceBeforeOperationRule - description: the type of rule - example: BuildMap - signature: - description: The rule's function signature. Describes the rule's input arguments and output (if any) - type: object - required: - - input - properties: - input: - type: array - items: - type: object - nullable: true - properties: - name: - type: string - description: the name of the argument - example: firstName - description: - type: string - description: the description of the argument - example: the first name of the identity - type: - type: string - nullable: true - description: the programmatic type of the argument - example: String - required: - - name - output: - $ref: '#/paths/~1connector-rules/post/requestBody/content/application~1json/schema/properties/signature/properties/input/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/Argument.yaml - sourceCode: - $ref: '#/paths/~1connector-rules~1validate/post/requestBody/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/SourceCode.yaml - attributes: - type: object - nullable: true - description: a map of string to objects - example: {} - responses: - '201': - description: Created connector rule. - content: - application/json: - schema: - $ref: '#/paths/~1connector-rules/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ConnectorRuleResponse.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml - security: - - userAuth: - - idn:rule-management-connector:manage - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/connector-rule-management#create-connector-rule - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $ConnectorRuleCreateRequest = @" - { - "sourceCode" : { - "version" : "1.0", - "script" : "return \"Mr. \" + firstName;" - }, - "signature" : { - "output" : { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - }, - "input" : [ { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - }, { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - } ] - }, - "name" : "WebServiceBeforeOperationRule", - "description" : "This rule does that", - "attributes" : { }, - "type" : "BuildMap" - } - "@ - - # Create Connector Rule - - try { - $Result = ConvertFrom-JsonToConnectorRuleCreateRequest -Json $ConnectorRuleCreateRequest - New-V2024ConnectorRule -XSailPointExperimental $XSailPointExperimental -ConnectorRuleCreateRequest $Result - - # Below is a request that includes all optional parameters - # New-V2024ConnectorRule -XSailPointExperimental $XSailPointExperimental -ConnectorRuleCreateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ConnectorRule" - Write-Host $_.ErrorDetails - } - /connector-rules/{id}: - get: - tags: - - Connector Rule Management - summary: Get Connector Rule - operationId: getConnectorRule - description: Get a connector rule by ID. - parameters: - - name: id - in: path - description: ID of the connector rule to get. - required: true - x-sailpoint-resource-operation-id: getConnectorRuleList - style: simple - explode: false - schema: - type: string - example: 8c190e6787aa4ed9a90bd9d5344523fb - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: Connector rule with the given ID. - content: - application/json: - schema: - $ref: '#/paths/~1connector-rules/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ConnectorRuleResponse.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml - security: - - userAuth: - - idn:rule-management-connector:read - - idn:rule-management-connector:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/connector-rule-management#get-connector-rule - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to get. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Connector Rule - - try { - Get-V2024ConnectorRule -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024ConnectorRule -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorRule" - Write-Host $_.ErrorDetails - } - put: - tags: - - Connector Rule Management - summary: Update Connector Rule - description: 'Update an existing connector rule with the one provided in the request body. These fields are immutable: `id`, `name`, `type`' - operationId: putConnectorRule - parameters: - - name: id - in: path - description: ID of the connector rule to update. - required: true - x-sailpoint-resource-operation-id: getConnectorRuleList - style: simple - explode: false - schema: - type: string - example: 8c190e6787aa4ed9a90bd9d5344523fb - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - description: Connector rule with updated data. - content: - application/json: - schema: - description: ConnectorRuleUpdateRequest - allOf: - - type: object - required: - - id - properties: - id: - type: string - description: the ID of the rule to update - example: 8113d48c0b914f17b4c6072d4dcb9dfe - - $ref: '#/paths/~1connector-rules/post/requestBody/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ConnectorRuleCreateRequest.yaml - responses: - '200': - description: Updated connector rule. - content: - application/json: - schema: - $ref: '#/paths/~1connector-rules/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ConnectorRuleResponse.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml - security: - - userAuth: - - idn:rule-management-connector:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/connector-rule-management#put-connector-rule - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to update. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $ConnectorRuleUpdateRequest = @" - { - "sourceCode" : { - "version" : "1.0", - "script" : "return \"Mr. \" + firstName;" - }, - "signature" : { - "output" : { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - }, - "input" : [ { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - }, { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - } ] - }, - "name" : "WebServiceBeforeOperationRule", - "description" : "This rule does that", - "attributes" : { }, - "id" : "8113d48c0b914f17b4c6072d4dcb9dfe", - "type" : "BuildMap" - } - "@ - - # Update Connector Rule - - try { - Send-V2024ConnectorRule -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Send-V2024ConnectorRule -Id $Id -XSailPointExperimental $XSailPointExperimental -ConnectorRuleUpdateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorRule" - Write-Host $_.ErrorDetails - } - delete: - tags: - - Connector Rule Management - summary: Delete Connector Rule - description: Delete the connector rule for the given ID. - operationId: deleteConnectorRule - parameters: - - name: id - in: path - description: ID of the connector rule to delete. - required: true - x-sailpoint-resource-operation-id: getConnectorRuleList - style: simple - explode: false - schema: - type: string - example: 8c190e6787aa4ed9a90bd9d5344523fb - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml - security: - - userAuth: - - idn:rule-management-connector:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/connector-rule-management#delete-connector-rule - source: | - $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to delete. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete Connector Rule - - try { - Remove-V2024ConnectorRule -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2024ConnectorRule -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ConnectorRule" - Write-Host $_.ErrorDetails - } - /connector-rules/validate: - post: - tags: - - Connector Rule Management - operationId: testConnectorRule - summary: Validate Connector Rule - description: Detect issues within the connector rule's code to fix and list them. - requestBody: - required: true - description: Code to validate. - content: - application/json: - schema: - description: SourceCode - type: object - required: - - version - - script - properties: - version: - type: string - description: the version of the code - example: '1.0' - script: - type: string - description: The code - example: return "Mr. " + firstName; - responses: - '200': - description: Status of the code's eligibility as a connector rule. - content: - application/json: - schema: - description: ConnectorRuleValidationResponse - type: object - required: - - state - - details - properties: - state: - type: string - enum: - - OK - - ERROR - example: ERROR - details: - type: array - items: - description: CodeErrorDetail - type: object - required: - - line - - column - - message - properties: - line: - type: integer - description: The line number where the issue occurred - example: 2 - column: - type: integer - description: the column number where the issue occurred - example: 5 - messsage: - type: string - description: a description of the issue in the code - example: Remove reference to .decrypt( - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml - security: - - userAuth: - - idn:rule-management-connector:read - - idn:rule-management-connector:manage - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/connector-rule-management#test-connector-rule - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SourceCode = @" - { - "version" : "1.0", - "script" : "return \"Mr. \" + firstName;" - } - "@ - - # Validate Connector Rule - - try { - $Result = ConvertFrom-JsonToSourceCode -Json $SourceCode - Test-V2024ConnectorRule -XSailPointExperimental $XSailPointExperimental -SourceCode $Result - - # Below is a request that includes all optional parameters - # Test-V2024ConnectorRule -XSailPointExperimental $XSailPointExperimental -SourceCode $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ConnectorRule" - Write-Host $_.ErrorDetails - } + with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121919ecca' # str | ID of the Auth Profile to patch. # str | ID of the Auth Profile to patch. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch_operation = '''[sailpoint.v2025.JsonPatchOperation()]''' # List[JsonPatchOperation] | + try: + # Patch a specified Auth Profile + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = AuthProfileApi(api_client).patch_profile_config(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = AuthProfileApi(api_client).patch_profile_config(id, x_sail_point_experimental, new_json_patch_operation) + print("The response of AuthProfileApi->patch_profile_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AuthProfileApi->patch_profile_config: %s\n" % e) /custom-password-instructions: post: operationId: createCustomPasswordInstructions @@ -51734,20 +71607,20 @@ paths: application/json: schema: $ref: '#/paths/~1custom-password-instructions/post/requestBody/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/CustomPasswordInstruction.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CustomPasswordInstruction.yaml example: pageId: reset-password:enter-password locale: default pageContent: See company password policies for details by clicking here '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -51759,7 +71632,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-password-instructions#create-custom-password-instructions + label: SDK_tools/sdk/powershell/v2025/methods/custom-password-instructions#create-custom-password-instructions source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $CustomPasswordInstruction = @" @@ -51774,14 +71647,42 @@ paths: try { $Result = ConvertFrom-JsonToCustomPasswordInstruction -Json $CustomPasswordInstruction - New-V2024CustomPasswordInstructions -XSailPointExperimental $XSailPointExperimental -CustomPasswordInstruction $Result + New-V2025CustomPasswordInstructions -XSailPointExperimental $XSailPointExperimental -CustomPasswordInstruction $Result # Below is a request that includes all optional parameters - # New-V2024CustomPasswordInstructions -XSailPointExperimental $XSailPointExperimental -CustomPasswordInstruction $Result + # New-V2025CustomPasswordInstructions -XSailPointExperimental $XSailPointExperimental -CustomPasswordInstruction $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CustomPasswordInstructions" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025CustomPasswordInstructions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/custom-password-instructions#create-custom-password-instructions + source: | + from sailpoint.v2025.api.custom_password_instructions_api import CustomPasswordInstructionsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.custom_password_instruction import CustomPasswordInstruction + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + custom_password_instruction = '''{ + "pageContent" : "Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter.", + "pageId" : "change-password:enter-password", + "locale" : "en" + }''' # CustomPasswordInstruction | + try: + # Create Custom Password Instructions + new_custom_password_instruction = CustomPasswordInstruction.from_json(custom_password_instruction) + results = CustomPasswordInstructionsApi(api_client).create_custom_password_instructions(x_sail_point_experimental=x_sail_point_experimental, custom_password_instruction=new_custom_password_instruction) + # Below is a request that includes all optional parameters + # results = CustomPasswordInstructionsApi(api_client).create_custom_password_instructions(x_sail_point_experimental, new_custom_password_instruction) + print("The response of CustomPasswordInstructionsApi->create_custom_password_instructions:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CustomPasswordInstructionsApi->create_custom_password_instructions: %s\n" % e) /custom-password-instructions/{pageId}: get: operationId: getCustomPasswordInstructions @@ -51834,26 +71735,26 @@ paths: application/json: schema: $ref: '#/paths/~1custom-password-instructions/post/requestBody/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/CustomPasswordInstruction.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CustomPasswordInstruction.yaml example: pageId: reset-password:enter-password locale: default pageContent: See company password policies for details by clicking here '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-password-instructions#get-custom-password-instructions + label: SDK_tools/sdk/powershell/v2025/methods/custom-password-instructions#get-custom-password-instructions source: | $PageId = "change-password:enter-password" # String | The page ID of custom password instructions to query. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -51862,14 +71763,39 @@ paths: # Get Custom Password Instructions by Page ID try { - Get-V2024CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental + Get-V2025CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental -Locale $Locale + # Get-V2025CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental -Locale $Locale } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CustomPasswordInstructions" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CustomPasswordInstructions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/custom-password-instructions#get-custom-password-instructions + source: | + from sailpoint.v2025.api.custom_password_instructions_api import CustomPasswordInstructionsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.custom_password_instruction import CustomPasswordInstruction + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + page_id = 'mfa:select' # str | The page ID of custom password instructions to query. # str | The page ID of custom password instructions to query. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + locale = 'locale_example' # str | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) # str | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) + try: + # Get Custom Password Instructions by Page ID + + results = CustomPasswordInstructionsApi(api_client).get_custom_password_instructions(page_id=page_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = CustomPasswordInstructionsApi(api_client).get_custom_password_instructions(page_id, x_sail_point_experimental, locale) + print("The response of CustomPasswordInstructionsApi->get_custom_password_instructions:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CustomPasswordInstructionsApi->get_custom_password_instructions: %s\n" % e) delete: operationId: deleteCustomPasswordInstructions tags: @@ -51917,22 +71843,22 @@ paths: responses: '204': $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/204.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-password-instructions#delete-custom-password-instructions + label: SDK_tools/sdk/powershell/v2025/methods/custom-password-instructions#delete-custom-password-instructions source: | $PageId = "change-password:enter-password" # String | The page ID of custom password instructions to delete. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -51941,14 +71867,36 @@ paths: # Delete Custom Password Instructions by page ID try { - Remove-V2024CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental + Remove-V2025CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Remove-V2024CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental -Locale $Locale + # Remove-V2025CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental -Locale $Locale } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CustomPasswordInstructions" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025CustomPasswordInstructions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/custom-password-instructions#delete-custom-password-instructions + source: | + from sailpoint.v2025.api.custom_password_instructions_api import CustomPasswordInstructionsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + page_id = 'mfa:select' # str | The page ID of custom password instructions to delete. # str | The page ID of custom password instructions to delete. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + locale = 'locale_example' # str | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) # str | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) + try: + # Delete Custom Password Instructions by page ID + + CustomPasswordInstructionsApi(api_client).delete_custom_password_instructions(page_id=page_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # CustomPasswordInstructionsApi(api_client).delete_custom_password_instructions(page_id, x_sail_point_experimental, locale) + except Exception as e: + print("Exception when calling CustomPasswordInstructionsApi->delete_custom_password_instructions: %s\n" % e) /entitlements: get: operationId: listEntitlements @@ -52001,11 +71949,11 @@ paths: example: true required: false - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - in: query name: sorters schema: @@ -52068,25 +72016,25 @@ paths: type: array items: $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/Entitlement.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Entitlement.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/entitlements#list-entitlements + label: SDK_tools/sdk/powershell/v2025/methods/entitlements#list-entitlements source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). (optional) @@ -52102,14 +72050,46 @@ paths: # Gets a list of entitlements. try { - Get-V2024Entitlements -XSailPointExperimental $XSailPointExperimental + Get-V2025Entitlements -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024Entitlements -XSailPointExperimental $XSailPointExperimental -AccountId $AccountId -SegmentedForIdentity $SegmentedForIdentity -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters + # Get-V2025Entitlements -XSailPointExperimental $XSailPointExperimental -AccountId $AccountId -SegmentedForIdentity $SegmentedForIdentity -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Entitlements" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Entitlements" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/entitlements#list-entitlements + source: | + from sailpoint.v2025.api.entitlements_api import EntitlementsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.entitlement import Entitlement + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). (optional) # str | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). (optional) + segmented_for_identity = 'me' # str | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) # str | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) + for_segment_ids = '041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649' # str | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) # str | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) + include_unsegmented = True # bool | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to True) # bool | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to True) + 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) + 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) + 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) + sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) + filters = 'attribute eq \"memberOf\"' # 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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) + try: + # Gets a list of entitlements. + + results = EntitlementsApi(api_client).list_entitlements(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = EntitlementsApi(api_client).list_entitlements(x_sail_point_experimental, account_id, segmented_for_identity, for_segment_ids, include_unsegmented, offset, limit, count, sorters, filters) + print("The response of EntitlementsApi->list_entitlements:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling EntitlementsApi->list_entitlements: %s\n" % e) /entitlements/{id}: get: operationId: getEntitlement @@ -52145,7 +72125,7 @@ paths: application/json: schema: $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/Entitlement.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Entitlement.yaml example: sourceSchemaObjectType: group attribute: memberOf @@ -52180,25 +72160,25 @@ paths: modified: '2021-01-19T16:53:35.707Z' '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/entitlements#get-entitlement + label: SDK_tools/sdk/powershell/v2025/methods/entitlements#get-entitlement source: | $Id = "2c91808874ff91550175097daaec161c" # String | The entitlement ID $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -52206,14 +72186,38 @@ paths: # Get an entitlement try { - Get-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2025Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental + # Get-V2025Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Entitlement" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Entitlement" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/entitlements#get-entitlement + source: | + from sailpoint.v2025.api.entitlements_api import EntitlementsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.entitlement import Entitlement + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '2c91808874ff91550175097daaec161c' # str | The entitlement ID # str | The entitlement ID + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get an entitlement + + results = EntitlementsApi(api_client).get_entitlement(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = EntitlementsApi(api_client).get_entitlement(id, x_sail_point_experimental) + print("The response of EntitlementsApi->get_entitlement:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling EntitlementsApi->get_entitlement: %s\n" % e) patch: operationId: patchEntitlement tags: @@ -52255,7 +72259,7 @@ paths: type: array items: $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/JsonPatchOperation.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml example: - op: replace path: /requestable @@ -52319,28 +72323,28 @@ paths: application/json: schema: $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/Entitlement.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Entitlement.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/entitlements#patch-entitlement + label: SDK_tools/sdk/powershell/v2025/methods/entitlements#patch-entitlement source: | $Id = "2c91808a7813090a017814121e121518" # String | ID of the entitlement to patch $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -52354,14 +72358,40 @@ paths: # Patch an entitlement try { - Update-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental + Update-V2025Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Update-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + # Update-V2025Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Entitlement" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Entitlement" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/entitlements#patch-entitlement + source: | + from sailpoint.v2025.api.entitlements_api import EntitlementsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.entitlement import Entitlement + from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121e121518' # str | ID of the entitlement to patch # str | ID of the entitlement to patch + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch_operation = '''[{op=replace, path=/requestable, value=true}, {op=replace, path=/privileged, value=true}]''' # List[JsonPatchOperation] | (optional) + try: + # Patch an entitlement + + results = EntitlementsApi(api_client).patch_entitlement(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = EntitlementsApi(api_client).patch_entitlement(id, x_sail_point_experimental, new_json_patch_operation) + print("The response of EntitlementsApi->patch_entitlement:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling EntitlementsApi->patch_entitlement: %s\n" % e) /entitlements/{id}/parents: get: operationId: listEntitlementParents @@ -52374,12 +72404,12 @@ paths: - idn:entitlement:read - idn:entitlement:manage parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - in: path name: id schema: @@ -52448,7 +72478,7 @@ paths: type: array items: $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/Entitlement.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Entitlement.yaml example: - sourceSchemaObjectType: group attribute: memberOf @@ -52483,25 +72513,25 @@ paths: modified: '2021-01-19T16:53:35.707Z' '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/entitlements#list-entitlement-parents + label: SDK_tools/sdk/powershell/v2025/methods/entitlements#list-entitlement-parents source: | $Id = "2c91808c74ff913f0175097daa9d59cd" # String | Entitlement Id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -52514,14 +72544,43 @@ paths: # List of entitlements parents try { - Get-V2024EntitlementParents -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2025EntitlementParents -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024EntitlementParents -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters + # Get-V2025EntitlementParents -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementParents" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementParents" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/entitlements#list-entitlement-parents + source: | + from sailpoint.v2025.api.entitlements_api import EntitlementsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.entitlement import Entitlement + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '2c91808c74ff913f0175097daa9d59cd' # str | Entitlement Id # str | Entitlement Id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) + filters = 'attribute eq \"memberOf\"' # 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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + try: + # List of entitlements parents + + results = EntitlementsApi(api_client).list_entitlement_parents(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = EntitlementsApi(api_client).list_entitlement_parents(id, x_sail_point_experimental, limit, offset, count, sorters, filters) + print("The response of EntitlementsApi->list_entitlement_parents:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling EntitlementsApi->list_entitlement_parents: %s\n" % e) /entitlements/{id}/children: get: operationId: listEntitlementChildren @@ -52533,12 +72592,12 @@ paths: - userAuth: - idn:entitlement:read parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - in: path name: id schema: @@ -52607,7 +72666,7 @@ paths: type: array items: $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/Entitlement.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Entitlement.yaml example: - sourceSchemaObjectType: group attribute: memberOf @@ -52642,25 +72701,25 @@ paths: modified: '2021-01-19T16:53:35.707Z' '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/entitlements#list-entitlement-children + label: SDK_tools/sdk/powershell/v2025/methods/entitlements#list-entitlement-children source: | $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -52673,14 +72732,43 @@ paths: # List of entitlements children try { - Get-V2024EntitlementChildren -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2025EntitlementChildren -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024EntitlementChildren -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters + # Get-V2025EntitlementChildren -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementChildren" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementChildren" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/entitlements#list-entitlement-children + source: | + from sailpoint.v2025.api.entitlements_api import EntitlementsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.entitlement import Entitlement + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) + filters = 'attribute eq \"memberOf\"' # 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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + try: + # List of entitlements children + + results = EntitlementsApi(api_client).list_entitlement_children(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = EntitlementsApi(api_client).list_entitlement_children(id, x_sail_point_experimental, limit, offset, count, sorters, filters) + print("The response of EntitlementsApi->list_entitlement_children:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling EntitlementsApi->list_entitlement_children: %s\n" % e) /entitlements/bulk-update: post: operationId: updateEntitlementsInBulk @@ -52718,56 +72806,8 @@ paths: jsonPatch: type: array items: - type: object - description: A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) - required: - - op - - path - properties: - op: - type: string - description: The operation to be performed - enum: - - add - - remove - - replace - - move - - copy - - test - example: replace - path: - type: string - description: A string JSON Pointer representing the target path to an element to be affected by the operation - example: /description - value: - oneOf: - - type: string - example: New description - title: string - - type: boolean - example: true - title: boolean - - type: integer - example: 300 - title: integer - - type: object - title: object - example: - attributes: - name: philip - - type: array - title: array - items: - anyOf: - - type: string - - type: integer - - type: object - example: - - '001' - - '002' - - '003' - description: The value to be used for the operation, required for "add" and "replace" operations - example: New description + $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml example: - op: replace path: /privileged @@ -52793,22 +72833,22 @@ paths: responses: '204': $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/204.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -52820,7 +72860,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/entitlements#update-entitlements-in-bulk + label: SDK_tools/sdk/powershell/v2025/methods/entitlements#update-entitlements-in-bulk source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $EntitlementBulkUpdateRequest = @" @@ -52842,14 +72882,47 @@ paths: try { $Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest - Update-V2024EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -EntitlementBulkUpdateRequest $Result + Update-V2025EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -EntitlementBulkUpdateRequest $Result # Below is a request that includes all optional parameters - # Update-V2024EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -EntitlementBulkUpdateRequest $Result + # Update-V2025EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -EntitlementBulkUpdateRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024EntitlementsInBulk" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025EntitlementsInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/entitlements#update-entitlements-in-bulk + source: | + from sailpoint.v2025.api.entitlements_api import EntitlementsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.entitlement_bulk_update_request import EntitlementBulkUpdateRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + entitlement_bulk_update_request = '''{ + "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], + "jsonPatch" : [ { + "op" : "replace", + "path" : "/privileged", + "value" : false + }, { + "op" : "replace", + "path" : "/requestable", + "value" : false + } ] + }''' # EntitlementBulkUpdateRequest | + try: + # Bulk update an entitlement list + new_entitlement_bulk_update_request = EntitlementBulkUpdateRequest.from_json(entitlement_bulk_update_request) + EntitlementsApi(api_client).update_entitlements_in_bulk(x_sail_point_experimental=x_sail_point_experimental, entitlement_bulk_update_request=new_entitlement_bulk_update_request) + # Below is a request that includes all optional parameters + # EntitlementsApi(api_client).update_entitlements_in_bulk(x_sail_point_experimental, new_entitlement_bulk_update_request) + except Exception as e: + print("Exception when calling EntitlementsApi->update_entitlements_in_bulk: %s\n" % e) /entitlements/{id}/entitlement-request-config: get: operationId: getEntitlementRequestConfig @@ -52925,25 +72998,25 @@ paths: approverId: 46c79819-a69f-49a2-becb-12c971ae66c6 '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/entitlements#get-entitlement-request-config + label: SDK_tools/sdk/powershell/v2025/methods/entitlements#get-entitlement-request-config source: | $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -52951,14 +73024,38 @@ paths: # Get Entitlement Request Config try { - Get-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2025EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental + # Get-V2025EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementRequestConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementRequestConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/entitlements#get-entitlement-request-config + source: | + from sailpoint.v2025.api.entitlements_api import EntitlementsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.entitlement_request_config import EntitlementRequestConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get Entitlement Request Config + + results = EntitlementsApi(api_client).get_entitlement_request_config(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = EntitlementsApi(api_client).get_entitlement_request_config(id, x_sail_point_experimental) + print("The response of EntitlementsApi->get_entitlement_request_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling EntitlementsApi->get_entitlement_request_config: %s\n" % e) put: operationId: putEntitlementRequestConfig tags: @@ -52991,7 +73088,7 @@ paths: application/json: schema: $ref: '#/paths/~1entitlements~1%7Bid%7D~1entitlement-request-config/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/EntitlementRequestConfig.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/EntitlementRequestConfig.yaml responses: '200': description: Responds with the entitlement request config as updated. @@ -52999,7 +73096,7 @@ paths: application/json: schema: $ref: '#/paths/~1entitlements~1%7Bid%7D~1entitlement-request-config/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/EntitlementRequestConfig.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/EntitlementRequestConfig.yaml example: accessRequestConfig: requestCommentRequired: true @@ -53015,25 +73112,25 @@ paths: approverId: 46c79819-a69f-49a2-becb-12c971ae66c6 '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/entitlements#put-entitlement-request-config + label: SDK_tools/sdk/powershell/v2025/methods/entitlements#put-entitlement-request-config source: | $Id = "2c91808a7813090a017814121e121518" # String | Entitlement ID $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -53050,14 +73147,44 @@ paths: try { $Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig - Send-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -EntitlementRequestConfig $Result + Send-V2025EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -EntitlementRequestConfig $Result # Below is a request that includes all optional parameters - # Send-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -EntitlementRequestConfig $Result + # Send-V2025EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -EntitlementRequestConfig $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024EntitlementRequestConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025EntitlementRequestConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/entitlements#put-entitlement-request-config + source: | + from sailpoint.v2025.api.entitlements_api import EntitlementsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.entitlement_request_config import EntitlementRequestConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121e121518' # str | Entitlement ID # str | Entitlement ID + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + entitlement_request_config = '''{ + "requestCommentsRequired" : false, + "deniedCommentsRequired" : false, + "allowEntitlementRequest" : true, + "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" + }''' # EntitlementRequestConfig | + try: + # Replace Entitlement Request Config + new_entitlement_request_config = EntitlementRequestConfig.from_json(entitlement_request_config) + results = EntitlementsApi(api_client).put_entitlement_request_config(id=id, x_sail_point_experimental=x_sail_point_experimental, entitlement_request_config=new_entitlement_request_config) + # Below is a request that includes all optional parameters + # results = EntitlementsApi(api_client).put_entitlement_request_config(id, x_sail_point_experimental, new_entitlement_request_config) + print("The response of EntitlementsApi->put_entitlement_request_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling EntitlementsApi->put_entitlement_request_config: %s\n" % e) /entitlements/reset/sources/{id}: post: operationId: resetSourceEntitlements @@ -53106,25 +73233,25 @@ paths: example: Entitlement Source Reset '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:entitlement:update x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/entitlements#reset-source-entitlements + label: SDK_tools/sdk/powershell/v2025/methods/entitlements#reset-source-entitlements source: | $Id = "2c91808a7813090a017814121919ecca" # String | ID of source for the entitlement reset $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -53132,14 +73259,38 @@ paths: # Reset Source Entitlements try { - Reset-V2024SourceEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental + Reset-V2025SourceEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Reset-V2024SourceEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental + # Reset-V2025SourceEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2024SourceEntitlements" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2025SourceEntitlements" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/entitlements#reset-source-entitlements + source: | + from sailpoint.v2025.api.entitlements_api import EntitlementsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.entitlement_source_reset_base_reference_dto import EntitlementSourceResetBaseReferenceDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121919ecca' # str | ID of source for the entitlement reset # str | ID of source for the entitlement reset + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Reset Source Entitlements + + results = EntitlementsApi(api_client).reset_source_entitlements(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = EntitlementsApi(api_client).reset_source_entitlements(id, x_sail_point_experimental) + print("The response of EntitlementsApi->reset_source_entitlements:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling EntitlementsApi->reset_source_entitlements: %s\n" % e) /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}: post: summary: Add metadata to an entitlement. @@ -53190,25 +73341,25 @@ paths: application/json: schema: $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/Entitlement.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Entitlement.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/entitlements#create-access-model-metadata-for-entitlement + label: SDK_tools/sdk/powershell/v2025/methods/entitlements#create-access-model-metadata-for-entitlement source: | $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. @@ -53218,14 +73369,40 @@ paths: # Add metadata to an entitlement. try { - New-V2024AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental + New-V2025AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # New-V2024AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental + # New-V2025AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AccessModelMetadataForEntitlement" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025AccessModelMetadataForEntitlement" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/entitlements#create-access-model-metadata-for-entitlement + source: | + from sailpoint.v2025.api.entitlements_api import EntitlementsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.entitlement import Entitlement + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '2c91808c74ff913f0175097daa9d59cd' # str | The entitlement id. # str | The entitlement id. + attribute_key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. + attribute_value = 'public' # str | Technical name of the Attribute Value. # str | Technical name of the Attribute Value. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Add metadata to an entitlement. + + results = EntitlementsApi(api_client).create_access_model_metadata_for_entitlement(id=id, attribute_key=attribute_key, attribute_value=attribute_value, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = EntitlementsApi(api_client).create_access_model_metadata_for_entitlement(id, attribute_key, attribute_value, x_sail_point_experimental) + print("The response of EntitlementsApi->create_access_model_metadata_for_entitlement:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling EntitlementsApi->create_access_model_metadata_for_entitlement: %s\n" % e) delete: summary: Remove metadata from an entitlement. description: Remove single Access Model Metadata from an entitlement. @@ -53273,22 +73450,22 @@ paths: description: OK '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/entitlements#delete-access-model-metadata-from-entitlement + label: SDK_tools/sdk/powershell/v2025/methods/entitlements#delete-access-model-metadata-from-entitlement source: | $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. @@ -53298,14 +73475,37 @@ paths: # Remove metadata from an entitlement. try { - Remove-V2024AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental + Remove-V2025AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Remove-V2024AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental + # Remove-V2025AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessModelMetadataFromEntitlement" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025AccessModelMetadataFromEntitlement" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/entitlements#delete-access-model-metadata-from-entitlement + source: | + from sailpoint.v2025.api.entitlements_api import EntitlementsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '2c91808c74ff913f0175097daa9d59cd' # str | The entitlement id. # str | The entitlement id. + attribute_key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. + attribute_value = 'public' # str | Technical name of the Attribute Value. # str | Technical name of the Attribute Value. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Remove metadata from an entitlement. + + EntitlementsApi(api_client).delete_access_model_metadata_from_entitlement(id=id, attribute_key=attribute_key, attribute_value=attribute_value, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # EntitlementsApi(api_client).delete_access_model_metadata_from_entitlement(id, attribute_key, attribute_value, x_sail_point_experimental) + except Exception as e: + print("Exception when calling EntitlementsApi->delete_access_model_metadata_from_entitlement: %s\n" % e) /entitlements/aggregate/sources/{id}: post: tags: @@ -53406,25 +73606,25 @@ paths: attributeName: groupsDeleted '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:entitlements:manage x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/entitlements#import-entitlements-by-source + label: SDK_tools/sdk/powershell/v2025/methods/entitlements#import-entitlements-by-source source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -53433,14 +73633,39 @@ paths: # Aggregate Entitlements try { - Import-V2024EntitlementsBySource -Id $Id -XSailPointExperimental $XSailPointExperimental + Import-V2025EntitlementsBySource -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Import-V2024EntitlementsBySource -Id $Id -XSailPointExperimental $XSailPointExperimental -CsvFile $CsvFile + # Import-V2025EntitlementsBySource -Id $Id -XSailPointExperimental $XSailPointExperimental -CsvFile $CsvFile } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024EntitlementsBySource" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025EntitlementsBySource" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/entitlements#import-entitlements-by-source + source: | + from sailpoint.v2025.api.entitlements_api import EntitlementsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.load_entitlement_task import LoadEntitlementTask + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + csv_file = None # bytearray | The CSV file containing the source entitlements to aggregate. (optional) # bytearray | The CSV file containing the source entitlements to aggregate. (optional) + try: + # Aggregate Entitlements + + results = EntitlementsApi(api_client).import_entitlements_by_source(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = EntitlementsApi(api_client).import_entitlements_by_source(id, x_sail_point_experimental, csv_file) + print("The response of EntitlementsApi->import_entitlements_by_source:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling EntitlementsApi->import_entitlements_by_source: %s\n" % e) /generate-password-reset-token/digit: post: operationId: createDigitToken @@ -53497,19 +73722,19 @@ paths: requestId: e1267ecd-fcd9-4c73-9c55-12555efad136 '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -53521,7 +73746,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/password-management#create-digit-token + label: SDK_tools/sdk/powershell/v2025/methods/password-management#create-digit-token source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $PasswordDigitTokenReset = @" @@ -53536,14 +73761,43 @@ paths: try { $Result = ConvertFrom-JsonToPasswordDigitTokenReset -Json $PasswordDigitTokenReset - New-V2024DigitToken -XSailPointExperimental $XSailPointExperimental -PasswordDigitTokenReset $Result + New-V2025DigitToken -XSailPointExperimental $XSailPointExperimental -PasswordDigitTokenReset $Result # Below is a request that includes all optional parameters - # New-V2024DigitToken -XSailPointExperimental $XSailPointExperimental -PasswordDigitTokenReset $Result + # New-V2025DigitToken -XSailPointExperimental $XSailPointExperimental -PasswordDigitTokenReset $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024DigitToken" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025DigitToken" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/password-management#create-digit-token + source: | + from sailpoint.v2025.api.password_management_api import PasswordManagementApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.password_digit_token import PasswordDigitToken + from sailpoint.v2025.models.password_digit_token_reset import PasswordDigitTokenReset + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + password_digit_token_reset = '''{ + "durationMinutes" : 5, + "length" : 8, + "userId" : "Abby.Smith" + }''' # PasswordDigitTokenReset | + try: + # Generate a digit token + new_password_digit_token_reset = PasswordDigitTokenReset.from_json(password_digit_token_reset) + results = PasswordManagementApi(api_client).create_digit_token(x_sail_point_experimental=x_sail_point_experimental, password_digit_token_reset=new_password_digit_token_reset) + # Below is a request that includes all optional parameters + # results = PasswordManagementApi(api_client).create_digit_token(x_sail_point_experimental, new_password_digit_token_reset) + print("The response of PasswordManagementApi->create_digit_token:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordManagementApi->create_digit_token: %s\n" % e) /historical-identities: get: operationId: listHistoricalIdentities @@ -53573,10 +73827,10 @@ paths: type: boolean description: Indicates if we want to only list active or inactive identities. example: true - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - name: X-SailPoint-Experimental in: header description: Use this header to enable this experimental API. @@ -53625,22 +73879,22 @@ paths: example: '2007-03-01T13:00:00.000Z' '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-history#list-historical-identities + label: SDK_tools/sdk/powershell/v2025/methods/identity-history#list-historical-identities source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $StartsWithQuery = "Ada" # String | This param is used for starts-with search for first, last and display name of the identity (optional) @@ -53652,14 +73906,42 @@ paths: # Lists all the identities try { - Get-V2024HistoricalIdentities -XSailPointExperimental $XSailPointExperimental + Get-V2025HistoricalIdentities -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024HistoricalIdentities -XSailPointExperimental $XSailPointExperimental -StartsWithQuery $StartsWithQuery -IsDeleted $IsDeleted -IsActive $IsActive -Limit $Limit -Offset $Offset + # Get-V2025HistoricalIdentities -XSailPointExperimental $XSailPointExperimental -StartsWithQuery $StartsWithQuery -IsDeleted $IsDeleted -IsActive $IsActive -Limit $Limit -Offset $Offset } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024HistoricalIdentities" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025HistoricalIdentities" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/identity-history#list-historical-identities + source: | + from sailpoint.v2025.api.identity_history_api import IdentityHistoryApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_list_item import IdentityListItem + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + starts_with_query = 'Ada' # str | This param is used for starts-with search for first, last and display name of the identity (optional) # str | This param is used for starts-with search for first, last and display name of the identity (optional) + is_deleted = true # bool | Indicates if we want to only list down deleted identities or not. (optional) # bool | Indicates if we want to only list down deleted identities or not. (optional) + is_active = true # bool | Indicates if we want to only list active or inactive identities. (optional) # bool | Indicates if we want to only list active or inactive identities. (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) + try: + # Lists all the identities + + results = IdentityHistoryApi(api_client).list_historical_identities(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IdentityHistoryApi(api_client).list_historical_identities(x_sail_point_experimental, starts_with_query, is_deleted, is_active, limit, offset) + print("The response of IdentityHistoryApi->list_historical_identities:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IdentityHistoryApi->list_historical_identities: %s\n" % e) /historical-identities/{id}: get: operationId: getHistoricalIdentity @@ -53735,22 +74017,22 @@ paths: department: HR '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-history#get-historical-identity + label: SDK_tools/sdk/powershell/v2025/methods/identity-history#get-historical-identity source: | $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -53758,14 +74040,38 @@ paths: # Get latest snapshot of identity try { - Get-V2024HistoricalIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2025HistoricalIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024HistoricalIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + # Get-V2025HistoricalIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024HistoricalIdentity" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025HistoricalIdentity" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/identity-history#get-historical-identity + source: | + from sailpoint.v2025.api.identity_history_api import IdentityHistoryApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_history_response import IdentityHistoryResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get latest snapshot of identity + + results = IdentityHistoryApi(api_client).get_historical_identity(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IdentityHistoryApi(api_client).get_historical_identity(id, x_sail_point_experimental) + print("The response of IdentityHistoryApi->get_historical_identity:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_historical_identity: %s\n" % e) /historical-identities/{id}/access-items: get: operationId: listIdentityAccessItems @@ -53805,12 +74111,12 @@ paths: type: string default: true required: true - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml responses: '200': description: The list of access items. @@ -54061,25 +74367,25 @@ paths: description: Role - Workday/Citizenship access '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-history#list-identity-access-items + label: SDK_tools/sdk/powershell/v2025/methods/identity-history#list-identity-access-items source: | $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -54091,14 +74397,42 @@ paths: # List Access Items by Identity try { - Get-V2024IdentityAccessItems -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2025IdentityAccessItems -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024IdentityAccessItems -Id $Id -XSailPointExperimental $XSailPointExperimental -Type $Type -Limit $Limit -Count $Count -Offset $Offset + # Get-V2025IdentityAccessItems -Id $Id -XSailPointExperimental $XSailPointExperimental -Type $Type -Limit $Limit -Count $Count -Offset $Offset } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessItems" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityAccessItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/identity-history#list-identity-access-items + source: | + from sailpoint.v2025.api.identity_history_api import IdentityHistoryApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.list_identity_access_items200_response_inner import ListIdentityAccessItems200ResponseInner + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + type = 'account' # str | The type of access item for the identity. If not provided, it defaults to account (optional) # str | The type of access item for the identity. If not provided, it defaults to account (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) + 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) + 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) + try: + # List Access Items by Identity + + results = IdentityHistoryApi(api_client).list_identity_access_items(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IdentityHistoryApi(api_client).list_identity_access_items(id, x_sail_point_experimental, type, limit, count, offset) + print("The response of IdentityHistoryApi->list_identity_access_items:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IdentityHistoryApi->list_identity_access_items: %s\n" % e) /historical-identities/{id}/snapshots: get: operationId: listIdentitySnapshots @@ -54129,12 +74463,12 @@ paths: - day - month description: The interval indicating the range in day or month for the specified interval-name - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - name: X-SailPoint-Experimental in: header description: Use this header to enable this experimental API. @@ -54159,22 +74493,22 @@ paths: example: '2007-03-01T13:00:00.000Z' '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-history#list-identity-snapshots + label: SDK_tools/sdk/powershell/v2025/methods/identity-history#list-identity-snapshots source: | $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -54187,14 +74521,43 @@ paths: # Lists all the snapshots for the identity try { - Get-V2024IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2025IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental -Start $Start -Interval $Interval -Limit $Limit -Offset $Offset -Count $Count + # Get-V2025IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental -Start $Start -Interval $Interval -Limit $Limit -Offset $Offset -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshots" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySnapshots" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/identity-history#list-identity-snapshots + source: | + from sailpoint.v2025.api.identity_history_api import IdentityHistoryApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_snapshot_summary_response import IdentitySnapshotSummaryResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + start = '2007-03-01T13:00:00Z' # str | The specified start date (optional) # str | The specified start date (optional) + interval = 'interval_example' # str | The interval indicating the range in day or month for the specified interval-name (optional) # str | The interval indicating the range in day or month for the specified interval-name (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 the snapshots for the identity + + results = IdentityHistoryApi(api_client).list_identity_snapshots(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IdentityHistoryApi(api_client).list_identity_snapshots(id, x_sail_point_experimental, start, interval, limit, offset, count) + print("The response of IdentityHistoryApi->list_identity_snapshots:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IdentityHistoryApi->list_identity_snapshots: %s\n" % e) /historical-identities/{id}/snapshot-summary: get: operationId: getIdentitySnapshotSummary @@ -54231,12 +74594,12 @@ paths: type: string description: The time zone. Defaults to UTC if not provided example: UTC - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - name: X-SailPoint-Experimental in: header description: Use this header to enable this experimental API. @@ -54266,22 +74629,22 @@ paths: value: 2 '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-history#get-identity-snapshot-summary + label: SDK_tools/sdk/powershell/v2025/methods/identity-history#get-identity-snapshot-summary source: | $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -54295,14 +74658,44 @@ paths: # Gets the summary for the event count for a specific identity try { - Get-V2024IdentitySnapshotSummary -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2025IdentitySnapshotSummary -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024IdentitySnapshotSummary -Id $Id -XSailPointExperimental $XSailPointExperimental -Before $Before -Interval $Interval -TimeZone $TimeZone -Limit $Limit -Offset $Offset -Count $Count + # Get-V2025IdentitySnapshotSummary -Id $Id -XSailPointExperimental $XSailPointExperimental -Before $Before -Interval $Interval -TimeZone $TimeZone -Limit $Limit -Offset $Offset -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshotSummary" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySnapshotSummary" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/identity-history#get-identity-snapshot-summary + source: | + from sailpoint.v2025.api.identity_history_api import IdentityHistoryApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.metric_response import MetricResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + before = '2007-03-01T13:00:00Z' # str | The date before which snapshot summary is required (optional) # str | The date before which snapshot summary is required (optional) + interval = 'interval_example' # str | The interval indicating day or month. Defaults to month if not specified (optional) # str | The interval indicating day or month. Defaults to month if not specified (optional) + time_zone = 'UTC' # str | The time zone. Defaults to UTC if not provided (optional) # str | The time zone. Defaults to UTC if not provided (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: + # Gets the summary for the event count for a specific identity + + results = IdentityHistoryApi(api_client).get_identity_snapshot_summary(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IdentityHistoryApi(api_client).get_identity_snapshot_summary(id, x_sail_point_experimental, before, interval, time_zone, limit, offset, count) + print("The response of IdentityHistoryApi->get_identity_snapshot_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_identity_snapshot_summary: %s\n" % e) /historical-identities/{id}/snapshots/{date}: get: operationId: getIdentitySnapshot @@ -54341,25 +74734,25 @@ paths: application/json: schema: $ref: '#/paths/~1historical-identities~1%7Bid%7D/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/IdentityHistoryResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/IdentityHistoryResponse.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-history#get-identity-snapshot + label: SDK_tools/sdk/powershell/v2025/methods/identity-history#get-identity-snapshot source: | $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id $Date = "2007-03-01T13:00:00Z" # String | The specified date @@ -54368,14 +74761,39 @@ paths: # Gets an identity snapshot at a given date try { - Get-V2024IdentitySnapshot -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental + Get-V2025IdentitySnapshot -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024IdentitySnapshot -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental + # Get-V2025IdentitySnapshot -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshot" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySnapshot" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/identity-history#get-identity-snapshot + source: | + from sailpoint.v2025.api.identity_history_api import IdentityHistoryApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_history_response import IdentityHistoryResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + var_date = '2007-03-01T13:00:00Z' # str | The specified date # str | The specified date + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Gets an identity snapshot at a given date + + results = IdentityHistoryApi(api_client).get_identity_snapshot(id=id, var_date=var_date, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IdentityHistoryApi(api_client).get_identity_snapshot(id, var_date, x_sail_point_experimental) + print("The response of IdentityHistoryApi->get_identity_snapshot:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_identity_snapshot: %s\n" % e) /historical-identities/{id}/snapshots/{date}/access-items: get: operationId: listIdentitySnapshotAccessItems @@ -54423,15 +74841,15 @@ paths: items: oneOf: - $ref: '#/paths/~1historical-identities~1%7Bid%7D~1access-items/get/responses/200/content/application~1json/schema/items/oneOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/AccessItemAccessProfileResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessItemAccessProfileResponse.yaml - $ref: '#/paths/~1historical-identities~1%7Bid%7D~1access-items/get/responses/200/content/application~1json/schema/items/oneOf/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/AccessItemAccountResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessItemAccountResponse.yaml - $ref: '#/paths/~1historical-identities~1%7Bid%7D~1access-items/get/responses/200/content/application~1json/schema/items/oneOf/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/AccessItemAppResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessItemAppResponse.yaml - $ref: '#/paths/~1historical-identities~1%7Bid%7D~1access-items/get/responses/200/content/application~1json/schema/items/oneOf/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/AccessItemEntitlementResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessItemEntitlementResponse.yaml - $ref: '#/paths/~1historical-identities~1%7Bid%7D~1access-items/get/responses/200/content/application~1json/schema/items/oneOf/4' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/AccessItemRoleResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessItemRoleResponse.yaml examples: Access Item AccessProfile Response: description: An access profile response @@ -54482,22 +74900,22 @@ paths: description: Role - Workday/Citizenship access '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-history#list-identity-snapshot-access-items + label: SDK_tools/sdk/powershell/v2025/methods/identity-history#list-identity-snapshot-access-items source: | $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id $Date = "2007-03-01T13:00:00Z" # String | The specified date @@ -54507,14 +74925,40 @@ paths: # Gets the list of identity access items at a given date filterd by item type try { - Get-V2024IdentitySnapshotAccessItems -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental + Get-V2025IdentitySnapshotAccessItems -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024IdentitySnapshotAccessItems -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental -Type $Type + # Get-V2025IdentitySnapshotAccessItems -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental -Type $Type } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshotAccessItems" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySnapshotAccessItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/identity-history#list-identity-snapshot-access-items + source: | + from sailpoint.v2025.api.identity_history_api import IdentityHistoryApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.list_identity_access_items200_response_inner import ListIdentityAccessItems200ResponseInner + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + var_date = '2007-03-01T13:00:00Z' # str | The specified date # str | The specified date + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + type = 'account' # str | The access item type (optional) # str | The access item type (optional) + try: + # Gets the list of identity access items at a given date filterd by item type + + results = IdentityHistoryApi(api_client).list_identity_snapshot_access_items(id=id, var_date=var_date, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IdentityHistoryApi(api_client).list_identity_snapshot_access_items(id, var_date, x_sail_point_experimental, type) + print("The response of IdentityHistoryApi->list_identity_snapshot_access_items:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IdentityHistoryApi->list_identity_snapshot_access_items: %s\n" % e) /common-access: get: operationId: getCommonAccess @@ -54524,11 +74968,11 @@ paths: description: This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read parameters: - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - in: query name: filters description: |- @@ -54636,19 +75080,19 @@ paths: example: false '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-common-access#get-common-access + label: SDK_tools/sdk/powershell/v2025/methods/iai-common-access#get-common-access source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $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) @@ -54660,14 +75104,42 @@ paths: # Get a paginated list of common access try { - Get-V2024CommonAccess -XSailPointExperimental $XSailPointExperimental + Get-V2025CommonAccess -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024CommonAccess -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters -Sorters $Sorters + # Get-V2025CommonAccess -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CommonAccess" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CommonAccess" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-common-access#get-common-access + source: | + from sailpoint.v2025.api.iai_common_access_api import IAICommonAccessApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.common_access_response import CommonAccessResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + 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) + 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) + filters = 'access.type eq \"ROLE\"' # 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: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* (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: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* (optional) + sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, status** By default the common access items are sorted by name, ascending. (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, status** By default the common access items are sorted by name, ascending. (optional) + try: + # Get a paginated list of common access + + results = IAICommonAccessApi(api_client).get_common_access(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAICommonAccessApi(api_client).get_common_access(x_sail_point_experimental, offset, limit, count, filters, sorters) + print("The response of IAICommonAccessApi->get_common_access:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAICommonAccessApi->get_common_access: %s\n" % e) post: operationId: createCommonAccess summary: Create common access items @@ -54683,7 +75155,7 @@ paths: properties: access: $ref: '#/paths/~1common-access/get/responses/200/content/application~1json/schema/items/properties/access' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/CommonAccessItemAccess.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CommonAccessItemAccess.yaml status: type: string enum: @@ -54703,10 +75175,10 @@ paths: description: Common Access Item ID access: $ref: '#/paths/~1common-access/get/responses/200/content/application~1json/schema/items/properties/access' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/CommonAccessItemAccess.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CommonAccessItemAccess.yaml status: $ref: '#/paths/~1common-access/post/requestBody/content/application~1json/schema/properties/status' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/CommonAccessItemState.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CommonAccessItemState.yaml lastUpdated: type: string reviewedByUser: @@ -54717,19 +75189,19 @@ paths: type: string '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -54741,7 +75213,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-common-access#create-common-access + label: SDK_tools/sdk/powershell/v2025/methods/iai-common-access#create-common-access source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $CommonAccessItemRequest = @" @@ -54762,14 +75234,49 @@ paths: try { $Result = ConvertFrom-JsonToCommonAccessItemRequest -Json $CommonAccessItemRequest - New-V2024CommonAccess -XSailPointExperimental $XSailPointExperimental -CommonAccessItemRequest $Result + New-V2025CommonAccess -XSailPointExperimental $XSailPointExperimental -CommonAccessItemRequest $Result # Below is a request that includes all optional parameters - # New-V2024CommonAccess -XSailPointExperimental $XSailPointExperimental -CommonAccessItemRequest $Result + # New-V2025CommonAccess -XSailPointExperimental $XSailPointExperimental -CommonAccessItemRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CommonAccess" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025CommonAccess" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-common-access#create-common-access + source: | + from sailpoint.v2025.api.iai_common_access_api import IAICommonAccessApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.common_access_item_request import CommonAccessItemRequest + from sailpoint.v2025.models.common_access_item_response import CommonAccessItemResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + common_access_item_request = '''{ + "access" : { + "ownerName" : "ownerName", + "name" : "name", + "description" : "description", + "id" : "id", + "type" : "ACCESS_PROFILE", + "ownerId" : "ownerId" + }, + "status" : "CONFIRMED" + }''' # CommonAccessItemRequest | + try: + # Create common access items + new_common_access_item_request = CommonAccessItemRequest.from_json(common_access_item_request) + results = IAICommonAccessApi(api_client).create_common_access(x_sail_point_experimental=x_sail_point_experimental, common_access_item_request=new_common_access_item_request) + # Below is a request that includes all optional parameters + # results = IAICommonAccessApi(api_client).create_common_access(x_sail_point_experimental, new_common_access_item_request) + print("The response of IAICommonAccessApi->create_common_access:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAICommonAccessApi->create_common_access: %s\n" % e) /common-access/update-status: post: operationId: updateCommonAccessStatusInBulk @@ -54802,22 +75309,22 @@ paths: responses: '202': $ref: '#/paths/~1access-requests~1cancel/post/responses/202' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/202.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/202.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -54829,7 +75336,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-common-access#update-common-access-status-in-bulk + label: SDK_tools/sdk/powershell/v2025/methods/iai-common-access#update-common-access-status-in-bulk source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $CommonAccessIDStatus = @"{ @@ -54842,14 +75349,38 @@ paths: try { $Result = ConvertFrom-JsonToCommonAccessIDStatus -Json $CommonAccessIDStatus - Update-V2024CommonAccessStatusInBulk -XSailPointExperimental $XSailPointExperimental -CommonAccessIDStatus $Result + Update-V2025CommonAccessStatusInBulk -XSailPointExperimental $XSailPointExperimental -CommonAccessIDStatus $Result # Below is a request that includes all optional parameters - # Update-V2024CommonAccessStatusInBulk -XSailPointExperimental $XSailPointExperimental -CommonAccessIDStatus $Result + # Update-V2025CommonAccessStatusInBulk -XSailPointExperimental $XSailPointExperimental -CommonAccessIDStatus $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024CommonAccessStatusInBulk" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025CommonAccessStatusInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-common-access#update-common-access-status-in-bulk + source: | + from sailpoint.v2025.api.iai_common_access_api import IAICommonAccessApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.common_access_id_status import CommonAccessIDStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + common_access_id_status = '''[sailpoint.v2025.CommonAccessIDStatus()]''' # List[CommonAccessIDStatus] | Confirm or deny in bulk the common access ids that are (or aren't) common access + try: + # Bulk update common access status + new_common_access_id_status = CommonAccessIdStatus.from_json(common_access_id_status) + results = IAICommonAccessApi(api_client).update_common_access_status_in_bulk(x_sail_point_experimental=x_sail_point_experimental, common_access_id_status=new_common_access_id_status) + # Below is a request that includes all optional parameters + # results = IAICommonAccessApi(api_client).update_common_access_status_in_bulk(x_sail_point_experimental, new_common_access_id_status) + print("The response of IAICommonAccessApi->update_common_access_status_in_bulk:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAICommonAccessApi->update_common_access_status_in_bulk: %s\n" % e) /historical-identities/{id}/events: get: operationId: getHistoricalIdentityEvents @@ -54892,12 +75423,12 @@ paths: example: - entitlement - account - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - name: X-SailPoint-Experimental in: header description: Use this header to enable this experimental API. @@ -54921,15 +75452,15 @@ paths: type: object oneOf: - $ref: '#/paths/~1historical-identities~1%7Bid%7D~1access-items/get/responses/200/content/application~1json/schema/items/oneOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/AccessItemAccessProfileResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessItemAccessProfileResponse.yaml - $ref: '#/paths/~1historical-identities~1%7Bid%7D~1access-items/get/responses/200/content/application~1json/schema/items/oneOf/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/AccessItemAccountResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessItemAccountResponse.yaml - $ref: '#/paths/~1historical-identities~1%7Bid%7D~1access-items/get/responses/200/content/application~1json/schema/items/oneOf/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/AccessItemAppResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessItemAppResponse.yaml - $ref: '#/paths/~1historical-identities~1%7Bid%7D~1access-items/get/responses/200/content/application~1json/schema/items/oneOf/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/AccessItemEntitlementResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessItemEntitlementResponse.yaml - $ref: '#/paths/~1historical-identities~1%7Bid%7D~1access-items/get/responses/200/content/application~1json/schema/items/oneOf/4' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/AccessItemRoleResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessItemRoleResponse.yaml example: id: 8c190e6787aa4ed9a90bd9d5344523fb accessType: account @@ -54976,7 +75507,7 @@ paths: description: The owners of the governance event (the certifiers or approvers) items: $ref: '#/paths/~1historical-identities~1%7Bid%7D~1events/get/responses/200/content/application~1json/schema/items/anyOf/4/properties/certifiers/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/CertifierResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CertifierResponse.yaml example: - id: 8a80828f643d484f01643e14202e206f displayName: John Snow @@ -54985,7 +75516,7 @@ paths: description: The owners of the governance event (the certifiers or approvers), this field should be preferred over owners items: $ref: '#/paths/~1historical-identities~1%7Bid%7D~1events/get/responses/200/content/application~1json/schema/items/anyOf/4/properties/certifiers/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/CertifierResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CertifierResponse.yaml example: - id: 8a80828f643d484f01643e14202e206f displayName: John Snow @@ -54995,22 +75526,22 @@ paths: example: id: 8a80828f643d484f01643e14202e206f displayName: John Snow - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/CertifierResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CertifierResponse.yaml - type: object properties: accessItem: type: object oneOf: - $ref: '#/paths/~1historical-identities~1%7Bid%7D~1access-items/get/responses/200/content/application~1json/schema/items/oneOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/AccessItemAccessProfileResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessItemAccessProfileResponse.yaml - $ref: '#/paths/~1historical-identities~1%7Bid%7D~1access-items/get/responses/200/content/application~1json/schema/items/oneOf/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/AccessItemAccountResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessItemAccountResponse.yaml - $ref: '#/paths/~1historical-identities~1%7Bid%7D~1access-items/get/responses/200/content/application~1json/schema/items/oneOf/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/AccessItemAppResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessItemAppResponse.yaml - $ref: '#/paths/~1historical-identities~1%7Bid%7D~1access-items/get/responses/200/content/application~1json/schema/items/oneOf/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/AccessItemEntitlementResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessItemEntitlementResponse.yaml - $ref: '#/paths/~1historical-identities~1%7Bid%7D~1access-items/get/responses/200/content/application~1json/schema/items/oneOf/4' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/AccessItemRoleResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AccessItemRoleResponse.yaml example: id: 8c190e6787aa4ed9a90bd9d5344523fb accessType: account @@ -55032,7 +75563,7 @@ paths: example: '2019-03-08T22:37:33.901Z' governanceEvent: $ref: '#/paths/~1historical-identities~1%7Bid%7D~1events/get/responses/200/content/application~1json/schema/items/anyOf/0/properties/governanceEvent' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/CorrelatedGovernanceEvent.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CorrelatedGovernanceEvent.yaml - type: object properties: changes: @@ -55200,13 +75731,13 @@ paths: description: The list of identities who review this certification items: $ref: '#/paths/~1historical-identities~1%7Bid%7D~1events/get/responses/200/content/application~1json/schema/items/anyOf/4/properties/certifiers/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/CertifierResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CertifierResponse.yaml example: - id: 8a80828f643d484f01643e14202e206f displayName: John Snow signer: $ref: '#/paths/~1historical-identities~1%7Bid%7D~1events/get/responses/200/content/application~1json/schema/items/anyOf/4/properties/certifiers/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/CertifierResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CertifierResponse.yaml eventType: type: string description: the event type @@ -55406,25 +75937,25 @@ paths: dt: '2019-03-08T22:37:33.901Z' '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-history#get-historical-identity-events + label: SDK_tools/sdk/powershell/v2025/methods/identity-history#get-historical-identity-events source: | $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -55442,14 +75973,44 @@ paths: # Lists all events for the given identity try { - Get-V2024HistoricalIdentityEvents -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2025HistoricalIdentityEvents -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024HistoricalIdentityEvents -Id $Id -XSailPointExperimental $XSailPointExperimental -From $From -EventTypes $EventTypes -AccessItemTypes $AccessItemTypes -Limit $Limit -Offset $Offset -Count $Count + # Get-V2025HistoricalIdentityEvents -Id $Id -XSailPointExperimental $XSailPointExperimental -From $From -EventTypes $EventTypes -AccessItemTypes $AccessItemTypes -Limit $Limit -Offset $Offset -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024HistoricalIdentityEvents" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025HistoricalIdentityEvents" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/identity-history#get-historical-identity-events + source: | + from sailpoint.v2025.api.identity_history_api import IdentityHistoryApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.get_historical_identity_events200_response_inner import GetHistoricalIdentityEvents200ResponseInner + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + var_from = '2024-03-01T13:00:00Z' # str | The optional instant until which access events are returned (optional) # str | The optional instant until which access events are returned (optional) + event_types = '''['[AccessAddedEvent, AccessRemovedEvent]']''' # List[str] | An optional list of event types to return. If null or empty, all events are returned (optional) + access_item_types = '''['[entitlement, account]']''' # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (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 events for the given identity + + results = IdentityHistoryApi(api_client).get_historical_identity_events(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IdentityHistoryApi(api_client).get_historical_identity_events(id, x_sail_point_experimental, var_from, event_types, access_item_types, limit, offset, count) + print("The response of IdentityHistoryApi->get_historical_identity_events:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_historical_identity_events: %s\n" % e) /historical-identities/{id}/start-date: get: operationId: getIdentityStartDate @@ -55484,22 +76045,22 @@ paths: example: '2017-03-01T13:00:00.000Z' '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-history#get-identity-start-date + label: SDK_tools/sdk/powershell/v2025/methods/identity-history#get-identity-start-date source: | $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -55507,14 +76068,37 @@ paths: # Gets the start date of the identity try { - Get-V2024IdentityStartDate -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2025IdentityStartDate -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024IdentityStartDate -Id $Id -XSailPointExperimental $XSailPointExperimental + # Get-V2025IdentityStartDate -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityStartDate" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityStartDate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/identity-history#get-identity-start-date + source: | + from sailpoint.v2025.api.identity_history_api import IdentityHistoryApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Gets the start date of the identity + + results = IdentityHistoryApi(api_client).get_identity_start_date(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IdentityHistoryApi(api_client).get_identity_start_date(id, x_sail_point_experimental) + print("The response of IdentityHistoryApi->get_identity_start_date:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IdentityHistoryApi->get_identity_start_date: %s\n" % e) /historical-identities/{id}/compare: get: operationId: compareIdentitySnapshots @@ -55550,12 +76134,12 @@ paths: items: type: string description: 'An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned ' - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - name: X-SailPoint-Experimental in: header description: Use this header to enable this experimental API. @@ -55592,22 +76176,22 @@ paths: accessRemoved: 1 '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-history#compare-identity-snapshots + label: SDK_tools/sdk/powershell/v2025/methods/identity-history#compare-identity-snapshots source: | $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -55623,14 +76207,44 @@ paths: # Gets a difference of count for each access item types for the given identity between 2 snapshots try { - Compare-V2024IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental + Compare-V2025IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Compare-V2024IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental -Snapshot1 $Snapshot1 -Snapshot2 $Snapshot2 -AccessItemTypes $AccessItemTypes -Limit $Limit -Offset $Offset -Count $Count + # Compare-V2025IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental -Snapshot1 $Snapshot1 -Snapshot2 $Snapshot2 -AccessItemTypes $AccessItemTypes -Limit $Limit -Offset $Offset -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-V2024IdentitySnapshots" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-V2025IdentitySnapshots" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/identity-history#compare-identity-snapshots + source: | + from sailpoint.v2025.api.identity_history_api import IdentityHistoryApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_compare_response import IdentityCompareResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + snapshot1 = '2007-03-01T13:00:00Z' # str | The snapshot 1 of identity (optional) # str | The snapshot 1 of identity (optional) + snapshot2 = '2008-03-01T13:00:00Z' # str | The snapshot 2 of identity (optional) # str | The snapshot 2 of identity (optional) + access_item_types = '''['access_item_types_example']''' # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (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: + # Gets a difference of count for each access item types for the given identity between 2 snapshots + + results = IdentityHistoryApi(api_client).compare_identity_snapshots(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IdentityHistoryApi(api_client).compare_identity_snapshots(id, x_sail_point_experimental, snapshot1, snapshot2, access_item_types, limit, offset, count) + print("The response of IdentityHistoryApi->compare_identity_snapshots:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IdentityHistoryApi->compare_identity_snapshots: %s\n" % e) /historical-identities/{id}/compare/{access-type}: get: operationId: compareIdentitySnapshotsAccessType @@ -55678,12 +76292,12 @@ paths: type: string description: The snapshot 2 of identity example: '2009-03-01T13:00:00Z' - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - name: X-SailPoint-Experimental in: header description: Use this header to enable this experimental API. @@ -55723,22 +76337,22 @@ paths: sourceName: Source '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-history#compare-identity-snapshots-access-type + label: SDK_tools/sdk/powershell/v2025/methods/identity-history#compare-identity-snapshots-access-type source: | $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id $AccessType = "accessProfile" # String | The specific type which needs to be compared @@ -55753,14 +76367,45 @@ paths: # Gets a list of differences of specific accessType for the given identity between 2 snapshots try { - Compare-V2024IdentitySnapshotsAccessType -Id $Id -AccessType $AccessType -XSailPointExperimental $XSailPointExperimental + Compare-V2025IdentitySnapshotsAccessType -Id $Id -AccessType $AccessType -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Compare-V2024IdentitySnapshotsAccessType -Id $Id -AccessType $AccessType -XSailPointExperimental $XSailPointExperimental -AccessAssociated $AccessAssociated -Snapshot1 $Snapshot1 -Snapshot2 $Snapshot2 -Limit $Limit -Offset $Offset -Count $Count + # Compare-V2025IdentitySnapshotsAccessType -Id $Id -AccessType $AccessType -XSailPointExperimental $XSailPointExperimental -AccessAssociated $AccessAssociated -Snapshot1 $Snapshot1 -Snapshot2 $Snapshot2 -Limit $Limit -Offset $Offset -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-V2024IdentitySnapshotsAccessType" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-V2025IdentitySnapshotsAccessType" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/identity-history#compare-identity-snapshots-access-type + source: | + from sailpoint.v2025.api.identity_history_api import IdentityHistoryApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.access_item_diff import AccessItemDiff + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id + access_type = 'role' # str | The specific type which needs to be compared # str | The specific type which needs to be compared + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + access_associated = 2007-03-01T13:00:00Z # bool | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) # bool | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) + snapshot1 = '2008-03-01T13:00:00Z' # str | The snapshot 1 of identity (optional) # str | The snapshot 1 of identity (optional) + snapshot2 = '2009-03-01T13:00:00Z' # str | The snapshot 2 of identity (optional) # str | The snapshot 2 of identity (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: + # Gets a list of differences of specific accessType for the given identity between 2 snapshots + + results = IdentityHistoryApi(api_client).compare_identity_snapshots_access_type(id=id, access_type=access_type, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IdentityHistoryApi(api_client).compare_identity_snapshots_access_type(id, access_type, x_sail_point_experimental, access_associated, snapshot1, snapshot2, limit, offset, count) + print("The response of IdentityHistoryApi->compare_identity_snapshots_access_type:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IdentityHistoryApi->compare_identity_snapshots_access_type: %s\n" % e) /identities/{identityId}/synchronize-attributes: post: operationId: synchronizeAttributesForIdentity @@ -55836,25 +76481,25 @@ paths: dataJson: '{"identityId":"2c918083746f642c01746f990884012a"}' '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identities#synchronize-attributes-for-identity + label: SDK_tools/sdk/powershell/v2025/methods/identities#synchronize-attributes-for-identity source: | $IdentityId = "MyIdentityId" # String | The Identity id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -55862,14 +76507,38 @@ paths: # Attribute synchronization for single identity. try { - Sync-V2024hronizeAttributesForIdentity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + Sync-V2025hronizeAttributesForIdentity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Sync-V2024hronizeAttributesForIdentity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + # Sync-V2025hronizeAttributesForIdentity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2024hronizeAttributesForIdentity" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2025hronizeAttributesForIdentity" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/identities#synchronize-attributes-for-identity + source: | + from sailpoint.v2025.api.identities_api import IdentitiesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_sync_job import IdentitySyncJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + identity_id = 'identity_id_example' # str | The Identity id # str | The Identity id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Attribute synchronization for single identity. + + results = IdentitiesApi(api_client).synchronize_attributes_for_identity(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IdentitiesApi(api_client).synchronize_attributes_for_identity(identity_id, x_sail_point_experimental) + print("The response of IdentitiesApi->synchronize_attributes_for_identity:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IdentitiesApi->synchronize_attributes_for_identity: %s\n" % e) /identities/{identityId}/ownership: get: operationId: getIdentityOwnershipDetails @@ -55952,25 +76621,25 @@ paths: type: ROLE '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identities#get-identity-ownership-details + label: SDK_tools/sdk/powershell/v2025/methods/identities#get-identity-ownership-details source: | $IdentityId = "ff8081814d2a8036014d701f3fbf53fa" # String | Identity ID. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -55978,14 +76647,38 @@ paths: # Get ownership details try { - Get-V2024IdentityOwnershipDetails -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + Get-V2025IdentityOwnershipDetails -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024IdentityOwnershipDetails -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + # Get-V2025IdentityOwnershipDetails -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityOwnershipDetails" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityOwnershipDetails" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/identities#get-identity-ownership-details + source: | + from sailpoint.v2025.api.identities_api import IdentitiesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_ownership_association_details import IdentityOwnershipAssociationDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + identity_id = 'ff8081814d2a8036014d701f3fbf53fa' # str | Identity ID. # str | Identity ID. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get ownership details + + results = IdentitiesApi(api_client).get_identity_ownership_details(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IdentitiesApi(api_client).get_identity_ownership_details(identity_id, x_sail_point_experimental) + print("The response of IdentitiesApi->get_identity_ownership_details:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IdentitiesApi->get_identity_ownership_details: %s\n" % e) /identities: get: operationId: listIdentities @@ -56056,11 +76749,11 @@ paths: NONE does not add any and returns all identities that satisfy filters query parameter. example: NONE - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - name: X-SailPoint-Experimental in: header description: Use this header to enable this experimental API. @@ -56196,22 +76889,22 @@ paths: description: Lifecycle state details that include lifecycle state name and whether this lifecycle state has been set manually '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identities#list-identities + label: SDK_tools/sdk/powershell/v2025/methods/identities#list-identities source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Filters = "id eq "6c9079b270a266a60170a2779fcb0006" or correlated eq false" # 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: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* (optional) @@ -56224,14 +76917,43 @@ paths: # List Identities try { - Get-V2024Identities -XSailPointExperimental $XSailPointExperimental + Get-V2025Identities -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024Identities -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Sorters $Sorters -DefaultFilter $DefaultFilter -Count $Count -Limit $Limit -Offset $Offset + # Get-V2025Identities -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Sorters $Sorters -DefaultFilter $DefaultFilter -Count $Count -Limit $Limit -Offset $Offset } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Identities" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Identities" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/identities#list-identities + source: | + from sailpoint.v2025.api.identities_api import IdentitiesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity import Identity + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + filters = 'id eq \"6c9079b270a266a60170a2779fcb0006\" or correlated eq false' # 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: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* (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: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* (optional) + sorters = 'name,-cloudStatus' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, alias, cloudStatus** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, alias, cloudStatus** (optional) + default_filter = CORRELATED_ONLY # str | Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. (optional) (default to CORRELATED_ONLY) # str | Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. (optional) (default to CORRELATED_ONLY) + 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) + 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) + try: + # List Identities + + results = IdentitiesApi(api_client).list_identities(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IdentitiesApi(api_client).list_identities(x_sail_point_experimental, filters, sorters, default_filter, count, limit, offset) + print("The response of IdentitiesApi->list_identities:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IdentitiesApi->list_identities: %s\n" % e) /identities/{id}: get: operationId: getIdentity @@ -56267,28 +76989,28 @@ paths: application/json: schema: $ref: '#/paths/~1identities/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/Identity.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Identity.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identities#get-identity + label: SDK_tools/sdk/powershell/v2025/methods/identities#get-identity source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -56296,14 +77018,38 @@ paths: # Identity Details try { - Get-V2024Identity -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2025Identity -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024Identity -Id $Id -XSailPointExperimental $XSailPointExperimental + # Get-V2025Identity -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Identity" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Identity" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/identities#get-identity + source: | + from sailpoint.v2025.api.identities_api import IdentitiesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity import Identity + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Identity Details + + results = IdentitiesApi(api_client).get_identity(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IdentitiesApi(api_client).get_identity(id, x_sail_point_experimental) + print("The response of IdentitiesApi->get_identity:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IdentitiesApi->get_identity: %s\n" % e) delete: operationId: deleteIdentity tags: @@ -56333,7 +77079,7 @@ paths: responses: '204': $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/204.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml '400': description: Client Error - Returned if the request is invalid. It may indicate that the specified identity is marked as protected and cannot be deleted. content: @@ -56360,7 +77106,7 @@ paths: description: the specific resource this identity has ownership on items: $ref: '#/paths/~1identities~1%7BidentityId%7D~1ownership/get/responses/200/content/application~1json/schema/properties/associationDetails/items/properties/entities/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/IdentityEntities.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/IdentityEntities.yaml example: id: b660a232f05b4e04812ca974b3011e0f name: Gaston.800ddf9640a @@ -56375,22 +77121,22 @@ paths: type: CAMPAIGN_CAMPAIGNER '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identities#delete-identity + label: SDK_tools/sdk/powershell/v2025/methods/identities#delete-identity source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -56398,14 +77144,35 @@ paths: # Delete identity try { - Remove-V2024Identity -Id $Id -XSailPointExperimental $XSailPointExperimental + Remove-V2025Identity -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Remove-V2024Identity -Id $Id -XSailPointExperimental $XSailPointExperimental + # Remove-V2025Identity -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Identity" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Identity" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/identities#delete-identity + source: | + from sailpoint.v2025.api.identities_api import IdentitiesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Delete identity + + IdentitiesApi(api_client).delete_identity(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # IdentitiesApi(api_client).delete_identity(id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling IdentitiesApi->delete_identity: %s\n" % e) /identities/invite: post: operationId: startIdentitiesInvite @@ -56667,6 +77434,7 @@ paths: type: string example: Cloud Account Aggregation description: + nullable: true description: Description of the TaskDefinition type: string example: Aggregates from the specified application. @@ -56683,27 +77451,32 @@ paths: description: Formal parameters of the TaskDefinition, without values type: object additionalProperties: true + example: + mantisExecutor: com.sailpoint.mantis.sources.task.AccountAggregationTask + eventClassesCsv: sailpoint.thunderbolt.events.AggregationEvents + serviceClass: sailpoint.thunderbolt.service.AggregationService + serviceMethod: accountAggregationTask '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identities#start-identities-invite + label: SDK_tools/sdk/powershell/v2025/methods/identities#start-identities-invite source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $InviteIdentitiesRequest = @" @@ -56717,14 +77490,42 @@ paths: try { $Result = ConvertFrom-JsonToInviteIdentitiesRequest -Json $InviteIdentitiesRequest - Start-V2024IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -InviteIdentitiesRequest $Result + Start-V2025IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -InviteIdentitiesRequest $Result # Below is a request that includes all optional parameters - # Start-V2024IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -InviteIdentitiesRequest $Result + # Start-V2025IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -InviteIdentitiesRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024IdentitiesInvite" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025IdentitiesInvite" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/identities#start-identities-invite + source: | + from sailpoint.v2025.api.identities_api import IdentitiesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.invite_identities_request import InviteIdentitiesRequest + from sailpoint.v2025.models.task_status import TaskStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + invite_identities_request = '''{ + "ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ], + "uninvited" : false + }''' # InviteIdentitiesRequest | + try: + # Invite identities to register + new_invite_identities_request = InviteIdentitiesRequest.from_json(invite_identities_request) + results = IdentitiesApi(api_client).start_identities_invite(x_sail_point_experimental=x_sail_point_experimental, invite_identities_request=new_invite_identities_request) + # Below is a request that includes all optional parameters + # results = IdentitiesApi(api_client).start_identities_invite(x_sail_point_experimental, new_invite_identities_request) + print("The response of IdentitiesApi->start_identities_invite:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IdentitiesApi->start_identities_invite: %s\n" % e) /identities/{id}/verification/account/send: post: operationId: sendIdentityVerificationAccountToken @@ -56782,25 +77583,25 @@ paths: description: The email was successfully sent '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identities#send-identity-verification-account-token + label: SDK_tools/sdk/powershell/v2025/methods/identities#send-identity-verification-account-token source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID @@ -56815,14 +77616,40 @@ paths: try { $Result = ConvertFrom-JsonToSendAccountVerificationRequest -Json $SendAccountVerificationRequest - Send-V2024IdentityVerificationAccountToken -XSailPointExperimental $XSailPointExperimental -Id $Id -SendAccountVerificationRequest $Result + Send-V2025IdentityVerificationAccountToken -XSailPointExperimental $XSailPointExperimental -Id $Id -SendAccountVerificationRequest $Result # Below is a request that includes all optional parameters - # Send-V2024IdentityVerificationAccountToken -XSailPointExperimental $XSailPointExperimental -Id $Id -SendAccountVerificationRequest $Result + # Send-V2025IdentityVerificationAccountToken -XSailPointExperimental $XSailPointExperimental -Id $Id -SendAccountVerificationRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024IdentityVerificationAccountToken" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025IdentityVerificationAccountToken" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/identities#send-identity-verification-account-token + source: | + from sailpoint.v2025.api.identities_api import IdentitiesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.send_account_verification_request import SendAccountVerificationRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID + send_account_verification_request = '''{ + "sourceName" : "Active Directory Source", + "via" : "EMAIL_WORK" + }''' # SendAccountVerificationRequest | + try: + # Send password reset email + new_send_account_verification_request = SendAccountVerificationRequest.from_json(send_account_verification_request) + IdentitiesApi(api_client).send_identity_verification_account_token(x_sail_point_experimental=x_sail_point_experimental, id=id, send_account_verification_request=new_send_account_verification_request) + # Below is a request that includes all optional parameters + # IdentitiesApi(api_client).send_identity_verification_account_token(x_sail_point_experimental, id, new_send_account_verification_request) + except Exception as e: + print("Exception when calling IdentitiesApi->send_identity_verification_account_token: %s\n" % e) /identities/process: post: operationId: startIdentityProcessing @@ -56884,22 +77711,22 @@ paths: example: 'null' '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -56911,7 +77738,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identities#start-identity-processing + label: SDK_tools/sdk/powershell/v2025/methods/identities#start-identity-processing source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $ProcessIdentitiesRequest = @" @@ -56924,14 +77751,41 @@ paths: try { $Result = ConvertFrom-JsonToProcessIdentitiesRequest -Json $ProcessIdentitiesRequest - Start-V2024IdentityProcessing -XSailPointExperimental $XSailPointExperimental -ProcessIdentitiesRequest $Result + Start-V2025IdentityProcessing -XSailPointExperimental $XSailPointExperimental -ProcessIdentitiesRequest $Result # Below is a request that includes all optional parameters - # Start-V2024IdentityProcessing -XSailPointExperimental $XSailPointExperimental -ProcessIdentitiesRequest $Result + # Start-V2025IdentityProcessing -XSailPointExperimental $XSailPointExperimental -ProcessIdentitiesRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024IdentityProcessing" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025IdentityProcessing" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/identities#start-identity-processing + source: | + from sailpoint.v2025.api.identities_api import IdentitiesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.process_identities_request import ProcessIdentitiesRequest + from sailpoint.v2025.models.task_result_response import TaskResultResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + process_identities_request = '''{ + "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] + }''' # ProcessIdentitiesRequest | + try: + # Process a list of identityIds + new_process_identities_request = ProcessIdentitiesRequest.from_json(process_identities_request) + results = IdentitiesApi(api_client).start_identity_processing(x_sail_point_experimental=x_sail_point_experimental, process_identities_request=new_process_identities_request) + # Below is a request that includes all optional parameters + # results = IdentitiesApi(api_client).start_identity_processing(x_sail_point_experimental, new_process_identities_request) + print("The response of IdentitiesApi->start_identity_processing:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IdentitiesApi->start_identity_processing: %s\n" % e) /identities/{id}/reset: post: operationId: resetIdentity @@ -56964,25 +77818,25 @@ paths: description: Accepted. The reset request accepted and is in progress. '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identities#reset-identity + label: SDK_tools/sdk/powershell/v2025/methods/identities#reset-identity source: | $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -56990,14 +77844,35 @@ paths: # Reset an identity try { - Reset-V2024Identity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + Reset-V2025Identity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Reset-V2024Identity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + # Reset-V2025Identity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2024Identity" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2025Identity" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/identities#reset-identity + source: | + from sailpoint.v2025.api.identities_api import IdentitiesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Reset an identity + + IdentitiesApi(api_client).reset_identity(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # IdentitiesApi(api_client).reset_identity(identity_id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling IdentitiesApi->reset_identity: %s\n" % e) /identities/{identityId}/role-assignments: get: operationId: getRoleAssignments @@ -57061,7 +77936,7 @@ paths: id: e7697a1e96d04db1ac7b0f4544915d2c type: ROLE name: Engineer - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/BaseReferenceDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BaseReferenceDto.yaml - type: object properties: id: @@ -57075,9 +77950,10 @@ paths: id: e7697a1e96d04db1ac7b0f4544915d2c type: ROLE name: Engineer - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/BaseReferenceDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BaseReferenceDto.yaml comments: type: string + nullable: true description: Comments added by the user when the assignment was made example: I'm a new Engineer and need this role to do my work assignmentSource: @@ -57085,13 +77961,25 @@ paths: description: Source describing how this assignment was made example: UI assigner: - $ref: '#/components/schemas/Account/allOf/1/properties/ownerIdentity/allOf/0' + type: object description: The identity that performed the assignment. This could be blank or system - example: - id: 2c9180867c184ff6017c2a2fbf031666 - type: IDENTITY - name: Jeff Richardson - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/BaseReferenceDto.yaml + properties: + type: + type: string + enum: + - IDENTITY + - UNKNOWN + description: Object type + example: IDENTITY + id: + type: string + description: ID of the object to which this reference applies + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + nullable: true + description: Human-readable display name of the object to which this reference applies + example: William Wilson assignedDimensions: type: array description: Dimensions assigned related to this role @@ -57101,62 +77989,76 @@ paths: name: Northeast region items: $ref: '#/components/schemas/Account/allOf/1/properties/ownerIdentity/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/BaseReferenceDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BaseReferenceDto.yaml assignmentContext: - type: object - properties: - requested: - type: object + allOf: + - type: object properties: - contextAttributes: + requested: + type: object + properties: + contextAttributes: + type: array + items: + type: object + properties: + attribute: + type: string + description: The name of the attribute + example: location + value: + oneOf: + - type: string + example: Austin + - type: array + items: + type: string + example: + - Austin + - Houston + - Dallas + description: The value of the attribute. This can be either a string or a multi-valued string + example: Austin + derived: + type: boolean + description: True if the attribute was derived. + default: false + example: false + matched: type: array items: type: object properties: - attribute: - type: string - description: The name of the attribute - example: location - value: - oneOf: - - type: string - example: Austin - - type: array - items: - type: string - example: - - Austin - - Houston - - Dallas - description: The value of the attribute. This can be either a string or a multi-valued string - example: Austin - derived: - type: boolean - description: True if the attribute was derived. - default: false - example: false + roleRef: + $ref: '#/components/schemas/Account/allOf/1/properties/ownerIdentity/allOf/0' + description: Role Id and Name related to this match + example: + id: e7697a1e96d04db1ac7b0f4544915d2c + type: DIMENSION + name: Engineer + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BaseReferenceDto.yaml + matchedAttributes: + type: array + items: + $ref: '#/paths/~1identities~1%7BidentityId%7D~1role-assignments/get/responses/200/content/application~1json/schema/items/anyOf/1/properties/assignmentContext/allOf/0/properties/requested/properties/contextAttributes/items' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ContextAttributeDto.yaml + computedDate: + type: string + description: Date that the assignment will was evaluated + example: Wed Feb 14 10:58:42 + - nullable: true + description: The context around the role assignment + example: + requested: + contextAttributes: + - attribute: department + value: Engineering + derived: false matched: - type: array - items: - type: object - properties: - roleRef: - $ref: '#/components/schemas/Account/allOf/1/properties/ownerIdentity/allOf/0' - description: Role Id and Name related to this match - example: - id: e7697a1e96d04db1ac7b0f4544915d2c - type: DIMENSION - name: Engineer - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/BaseReferenceDto.yaml - matchedAttributes: - type: array - items: - $ref: '#/paths/~1identities~1%7BidentityId%7D~1role-assignments/get/responses/200/content/application~1json/schema/items/anyOf/1/properties/assignmentContext/properties/requested/properties/contextAttributes/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ContextAttributeDto.yaml - computedDate: - type: string - description: Date that the assignment will was evaluated - example: Wed Feb 14 10:58:42 + - id: e7697a1e96d04db1ac7b0f4544915d2c + type: DIMENSION + name: Engineer + computedDate: Wed Feb 14 10:58:42 accountTargets: type: array items: @@ -57169,7 +78071,7 @@ paths: id: d18b74853739439986501ad180b27db6 type: SOURCE name: Active Directory - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/BaseReferenceDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BaseReferenceDto.yaml accountInfo: type: object properties: @@ -57191,29 +78093,30 @@ paths: example: Marketing removeDate: type: string + nullable: true description: Date that the assignment will be removed example: Wed Feb 14 10:58:42 '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identities#get-role-assignments + label: SDK_tools/sdk/powershell/v2025/methods/identities#get-role-assignments source: | $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id to get the role assignments for $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -57223,14 +78126,40 @@ paths: # List role assignments try { - Get-V2024RoleAssignments -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + Get-V2025RoleAssignments -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024RoleAssignments -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -RoleId $RoleId -RoleName $RoleName + # Get-V2025RoleAssignments -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -RoleId $RoleId -RoleName $RoleName } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleAssignments" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleAssignments" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/identities#get-role-assignments + source: | + from sailpoint.v2025.api.identities_api import IdentitiesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.get_role_assignments200_response_inner import GetRoleAssignments200ResponseInner + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id to get the role assignments for # str | Identity Id to get the role assignments for + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + role_id = 'e7697a1e96d04db1ac7b0f4544915d2c' # str | Role Id to filter the role assignments with (optional) # str | Role Id to filter the role assignments with (optional) + role_name = 'Engineer' # str | Role name to filter the role assignments with (optional) # str | Role name to filter the role assignments with (optional) + try: + # List role assignments + + results = IdentitiesApi(api_client).get_role_assignments(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IdentitiesApi(api_client).get_role_assignments(identity_id, x_sail_point_experimental, role_id, role_name) + print("The response of IdentitiesApi->get_role_assignments:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IdentitiesApi->get_role_assignments: %s\n" % e) /identities/{identityId}/role-assignments/{assignmentId}: get: operationId: getRoleAssignment @@ -57272,28 +78201,28 @@ paths: application/json: schema: $ref: '#/paths/~1identities~1%7BidentityId%7D~1role-assignments/get/responses/200/content/application~1json/schema/items/anyOf/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/RoleAssignmentDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleAssignmentDto.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identities#get-role-assignment + label: SDK_tools/sdk/powershell/v2025/methods/identities#get-role-assignment source: | $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id $AssignmentId = "1cbb0705b38c4226b1334eadd8874086" # String | Assignment Id @@ -57302,14 +78231,39 @@ paths: # Role assignment details try { - Get-V2024RoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId -XSailPointExperimental $XSailPointExperimental + Get-V2025RoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024RoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId -XSailPointExperimental $XSailPointExperimental + # Get-V2025RoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleAssignment" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleAssignment" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/identities#get-role-assignment + source: | + from sailpoint.v2025.api.identities_api import IdentitiesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.role_assignment_dto import RoleAssignmentDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id + assignment_id = '1cbb0705b38c4226b1334eadd8874086' # str | Assignment Id # str | Assignment Id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Role assignment details + + results = IdentitiesApi(api_client).get_role_assignment(identity_id=identity_id, assignment_id=assignment_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IdentitiesApi(api_client).get_role_assignment(identity_id, assignment_id, x_sail_point_experimental) + print("The response of IdentitiesApi->get_role_assignment:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IdentitiesApi->get_role_assignment: %s\n" % e) /identity-attributes: get: operationId: listIdentityAttributes @@ -57346,7 +78300,7 @@ paths: required: false example: false - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - name: X-SailPoint-Experimental in: header description: Use this header to enable this experimental API. @@ -57418,22 +78372,22 @@ paths: ruleName: Cloud Promote Identity Attribute '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-attributes#list-identity-attributes + label: SDK_tools/sdk/powershell/v2025/methods/identity-attributes#list-identity-attributes source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $IncludeSystem = $false # Boolean | Include 'system' attributes in the response. (optional) (default to $false) @@ -57444,14 +78398,41 @@ paths: # List Identity Attributes try { - Get-V2024IdentityAttributes -XSailPointExperimental $XSailPointExperimental + Get-V2025IdentityAttributes -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024IdentityAttributes -XSailPointExperimental $XSailPointExperimental -IncludeSystem $IncludeSystem -IncludeSilent $IncludeSilent -SearchableOnly $SearchableOnly -Count $Count + # Get-V2025IdentityAttributes -XSailPointExperimental $XSailPointExperimental -IncludeSystem $IncludeSystem -IncludeSilent $IncludeSilent -SearchableOnly $SearchableOnly -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAttributes" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityAttributes" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/identity-attributes#list-identity-attributes + source: | + from sailpoint.v2025.api.identity_attributes_api import IdentityAttributesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_attribute import IdentityAttribute + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + include_system = False # bool | Include 'system' attributes in the response. (optional) (default to False) # bool | Include 'system' attributes in the response. (optional) (default to False) + include_silent = False # bool | Include 'silent' attributes in the response. (optional) (default to False) # bool | Include 'silent' attributes in the response. (optional) (default to False) + searchable_only = False # bool | Include only 'searchable' attributes in the response. (optional) (default to False) # bool | Include only 'searchable' attributes in the response. (optional) (default to False) + 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 Attributes + + results = IdentityAttributesApi(api_client).list_identity_attributes(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IdentityAttributesApi(api_client).list_identity_attributes(x_sail_point_experimental, include_system, include_silent, searchable_only, count) + print("The response of IdentityAttributesApi->list_identity_attributes:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IdentityAttributesApi->list_identity_attributes: %s\n" % e) post: operationId: createIdentityAttribute tags: @@ -57467,7 +78448,7 @@ paths: application/json: schema: $ref: '#/paths/~1identity-attributes/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/identity-attributes/IdentityAttribute.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/identity-attributes/IdentityAttribute.yaml responses: '201': description: The identity attribute was created successfully. @@ -57475,25 +78456,25 @@ paths: application/json: schema: $ref: '#/paths/~1identity-attributes/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/identity-attributes/IdentityAttribute.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/identity-attributes/IdentityAttribute.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -57505,7 +78486,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-attributes#create-identity-attribute + label: SDK_tools/sdk/powershell/v2025/methods/identity-attributes#create-identity-attribute source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $IdentityAttribute = @" @@ -57537,14 +78518,59 @@ paths: try { $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute - New-V2024IdentityAttribute -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result + New-V2025IdentityAttribute -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result # Below is a request that includes all optional parameters - # New-V2024IdentityAttribute -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result + # New-V2025IdentityAttribute -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024IdentityAttribute" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025IdentityAttribute" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/identity-attributes#create-identity-attribute + source: | + from sailpoint.v2025.api.identity_attributes_api import IdentityAttributesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_attribute import IdentityAttribute + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + identity_attribute = '''{ + "standard" : false, + "system" : false, + "sources" : [ { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + }, { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + } ], + "displayName" : "Cost Center", + "name" : "costCenter", + "type" : "string", + "searchable" : false, + "multi" : false + }''' # IdentityAttribute | + try: + # Create Identity Attribute + new_identity_attribute = IdentityAttribute.from_json(identity_attribute) + results = IdentityAttributesApi(api_client).create_identity_attribute(x_sail_point_experimental=x_sail_point_experimental, identity_attribute=new_identity_attribute) + # Below is a request that includes all optional parameters + # results = IdentityAttributesApi(api_client).create_identity_attribute(x_sail_point_experimental, new_identity_attribute) + print("The response of IdentityAttributesApi->create_identity_attribute:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IdentityAttributesApi->create_identity_attribute: %s\n" % e) /identity-attributes/{name}: get: operationId: getIdentityAttribute @@ -57579,28 +78605,28 @@ paths: application/json: schema: $ref: '#/paths/~1identity-attributes/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/identity-attributes/IdentityAttribute.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/identity-attributes/IdentityAttribute.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-attributes#get-identity-attribute + label: SDK_tools/sdk/powershell/v2025/methods/identity-attributes#get-identity-attribute source: | $Name = "displayName" # String | The attribute's technical name. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -57608,14 +78634,38 @@ paths: # Get Identity Attribute try { - Get-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental + Get-V2025IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental + # Get-V2025IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAttribute" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityAttribute" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/identity-attributes#get-identity-attribute + source: | + from sailpoint.v2025.api.identity_attributes_api import IdentityAttributesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_attribute import IdentityAttribute + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get Identity Attribute + + results = IdentityAttributesApi(api_client).get_identity_attribute(name=name, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IdentityAttributesApi(api_client).get_identity_attribute(name, x_sail_point_experimental) + print("The response of IdentityAttributesApi->get_identity_attribute:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IdentityAttributesApi->get_identity_attribute: %s\n" % e) put: operationId: putIdentityAttribute tags: @@ -57648,7 +78698,7 @@ paths: application/json: schema: $ref: '#/paths/~1identity-attributes/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/identity-attributes/IdentityAttribute.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/identity-attributes/IdentityAttribute.yaml responses: '200': description: The identity attribute was updated successfully @@ -57656,28 +78706,28 @@ paths: application/json: schema: $ref: '#/paths/~1identity-attributes/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/identity-attributes/IdentityAttribute.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/identity-attributes/IdentityAttribute.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-attributes#put-identity-attribute + label: SDK_tools/sdk/powershell/v2025/methods/identity-attributes#put-identity-attribute source: | $Name = "displayName" # String | The attribute's technical name. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -57710,14 +78760,60 @@ paths: try { $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute - Send-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result + Send-V2025IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result # Below is a request that includes all optional parameters - # Send-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result + # Send-V2025IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024IdentityAttribute" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025IdentityAttribute" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/identity-attributes#put-identity-attribute + source: | + from sailpoint.v2025.api.identity_attributes_api import IdentityAttributesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_attribute import IdentityAttribute + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + identity_attribute = '''{ + "standard" : false, + "system" : false, + "sources" : [ { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + }, { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + } ], + "displayName" : "Cost Center", + "name" : "costCenter", + "type" : "string", + "searchable" : false, + "multi" : false + }''' # IdentityAttribute | + try: + # Update Identity Attribute + new_identity_attribute = IdentityAttribute.from_json(identity_attribute) + results = IdentityAttributesApi(api_client).put_identity_attribute(name=name, x_sail_point_experimental=x_sail_point_experimental, identity_attribute=new_identity_attribute) + # Below is a request that includes all optional parameters + # results = IdentityAttributesApi(api_client).put_identity_attribute(name, x_sail_point_experimental, new_identity_attribute) + print("The response of IdentityAttributesApi->put_identity_attribute:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IdentityAttributesApi->put_identity_attribute: %s\n" % e) delete: operationId: deleteIdentityAttribute tags: @@ -57747,28 +78843,28 @@ paths: responses: '204': $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/204.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-attributes#delete-identity-attribute + label: SDK_tools/sdk/powershell/v2025/methods/identity-attributes#delete-identity-attribute source: | $Name = "displayName" # String | The attribute's technical name. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -57776,14 +78872,35 @@ paths: # Delete Identity Attribute try { - Remove-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental + Remove-V2025IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Remove-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental + # Remove-V2025IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityAttribute" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025IdentityAttribute" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/identity-attributes#delete-identity-attribute + source: | + from sailpoint.v2025.api.identity_attributes_api import IdentityAttributesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Delete Identity Attribute + + IdentityAttributesApi(api_client).delete_identity_attribute(name=name, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # IdentityAttributesApi(api_client).delete_identity_attribute(name, x_sail_point_experimental) + except Exception as e: + print("Exception when calling IdentityAttributesApi->delete_identity_attribute: %s\n" % e) /identity-attributes/bulk-delete: delete: operationId: deleteIdentityAttributesInBulk @@ -57814,25 +78931,25 @@ paths: responses: '204': $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/204.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -57844,7 +78961,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/identity-attributes#delete-identity-attributes-in-bulk + label: SDK_tools/sdk/powershell/v2025/methods/identity-attributes#delete-identity-attributes-in-bulk source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $IdentityAttributeNames = @" @@ -57857,14 +78974,38 @@ paths: try { $Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames - Remove-V2024IdentityAttributesInBulk -XSailPointExperimental $XSailPointExperimental -IdentityAttributeNames $Result + Remove-V2025IdentityAttributesInBulk -XSailPointExperimental $XSailPointExperimental -IdentityAttributeNames $Result # Below is a request that includes all optional parameters - # Remove-V2024IdentityAttributesInBulk -XSailPointExperimental $XSailPointExperimental -IdentityAttributeNames $Result + # Remove-V2025IdentityAttributesInBulk -XSailPointExperimental $XSailPointExperimental -IdentityAttributeNames $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityAttributesInBulk" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025IdentityAttributesInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/identity-attributes#delete-identity-attributes-in-bulk + source: | + from sailpoint.v2025.api.identity_attributes_api import IdentityAttributesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_attribute_names import IdentityAttributeNames + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + identity_attribute_names = '''{ + "ids" : [ "name", "displayName" ] + }''' # IdentityAttributeNames | + try: + # Bulk delete Identity Attributes + new_identity_attribute_names = IdentityAttributeNames.from_json(identity_attribute_names) + IdentityAttributesApi(api_client).delete_identity_attributes_in_bulk(x_sail_point_experimental=x_sail_point_experimental, identity_attribute_names=new_identity_attribute_names) + # Below is a request that includes all optional parameters + # IdentityAttributesApi(api_client).delete_identity_attributes_in_bulk(x_sail_point_experimental, new_identity_attribute_names) + except Exception as e: + print("Exception when calling IdentityAttributesApi->delete_identity_attributes_in_bulk: %s\n" % e) /mail-from-attributes: put: security: @@ -57929,19 +79070,19 @@ paths: description: MAIL FROM attributes for a domain / identity '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -57953,7 +79094,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/notifications#put-mail-from-attributes + label: SDK_tools/sdk/powershell/v2025/methods/notifications#put-mail-from-attributes source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $MailFromAttributesDto = @" @@ -57967,14 +79108,42 @@ paths: try { $Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto - Send-V2024MailFromAttributes -XSailPointExperimental $XSailPointExperimental -MailFromAttributesDto $Result + Send-V2025MailFromAttributes -XSailPointExperimental $XSailPointExperimental -MailFromAttributesDto $Result # Below is a request that includes all optional parameters - # Send-V2024MailFromAttributes -XSailPointExperimental $XSailPointExperimental -MailFromAttributesDto $Result + # Send-V2025MailFromAttributes -XSailPointExperimental $XSailPointExperimental -MailFromAttributesDto $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024MailFromAttributes" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025MailFromAttributes" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/notifications#put-mail-from-attributes + source: | + from sailpoint.v2025.api.notifications_api import NotificationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.mail_from_attributes import MailFromAttributes + from sailpoint.v2025.models.mail_from_attributes_dto import MailFromAttributesDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + mail_from_attributes_dto = '''{ + "identity" : "BobSmith@sailpoint.com", + "mailFromDomain" : "example.sailpoint.com" + }''' # MailFromAttributesDto | + try: + # Change MAIL FROM domain + new_mail_from_attributes_dto = MailFromAttributesDto.from_json(mail_from_attributes_dto) + results = NotificationsApi(api_client).put_mail_from_attributes(x_sail_point_experimental=x_sail_point_experimental, mail_from_attributes_dto=new_mail_from_attributes_dto) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).put_mail_from_attributes(x_sail_point_experimental, new_mail_from_attributes_dto) + print("The response of NotificationsApi->put_mail_from_attributes:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NotificationsApi->put_mail_from_attributes: %s\n" % e) /mail-from-attributes/{identity}: get: security: @@ -58008,25 +79177,25 @@ paths: application/json: schema: $ref: '#/paths/~1mail-from-attributes/put/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/MailFromAttributes.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/MailFromAttributes.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/notifications#get-mail-from-attributes + label: SDK_tools/sdk/powershell/v2025/methods/notifications#get-mail-from-attributes source: | $Id = "bobsmith@sailpoint.com" # String | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -58034,14 +79203,38 @@ paths: # Get MAIL FROM Attributes try { - Get-V2024MailFromAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2025MailFromAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024MailFromAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental + # Get-V2025MailFromAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MailFromAttributes" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MailFromAttributes" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/notifications#get-mail-from-attributes + source: | + from sailpoint.v2025.api.notifications_api import NotificationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.mail_from_attributes import MailFromAttributes + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = 'bobsmith@sailpoint.com' # str | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status # str | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get MAIL FROM Attributes + + results = NotificationsApi(api_client).get_mail_from_attributes(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).get_mail_from_attributes(id, x_sail_point_experimental) + print("The response of NotificationsApi->get_mail_from_attributes:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NotificationsApi->get_mail_from_attributes: %s\n" % e) /generic-approvals: get: security: @@ -58184,7 +79377,7 @@ paths: description: The priority of the approval requester: $ref: '#/paths/~1generic-approvals/get/responses/200/content/application~1json/schema/items/properties/approvers/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ApprovalIdentity.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ApprovalIdentity.yaml comments: type: array items: @@ -58192,7 +79385,7 @@ paths: properties: author: $ref: '#/paths/~1generic-approvals/get/responses/200/content/application~1json/schema/items/properties/approvers/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ApprovalIdentity.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ApprovalIdentity.yaml comment: type: string example: Looks good @@ -58207,13 +79400,13 @@ paths: type: array items: $ref: '#/paths/~1generic-approvals/get/responses/200/content/application~1json/schema/items/properties/approvers/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ApprovalIdentity.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ApprovalIdentity.yaml description: Array of approvers who have approved the approval rejectedBy: type: array items: $ref: '#/paths/~1generic-approvals/get/responses/200/content/application~1json/schema/items/properties/approvers/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ApprovalIdentity.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ApprovalIdentity.yaml description: Array of approvers who have rejected the approval completedDate: type: string @@ -58260,22 +79453,22 @@ paths: description: Approval Object '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/approvals#get-approvals + label: SDK_tools/sdk/powershell/v2025/methods/approvals#get-approvals source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Mine = $true # Boolean | Returns the list of approvals for the current caller (optional) @@ -58285,14 +79478,40 @@ paths: # Get Approvals try { - Get-V2024Approvals -XSailPointExperimental $XSailPointExperimental + Get-V2025Approvals -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024Approvals -XSailPointExperimental $XSailPointExperimental -Mine $Mine -RequesterId $RequesterId -Filters $Filters + # Get-V2025Approvals -XSailPointExperimental $XSailPointExperimental -Mine $Mine -RequesterId $RequesterId -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Approvals" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Approvals" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/approvals#get-approvals + source: | + from sailpoint.v2025.api.approvals_api import ApprovalsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.approval import Approval + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + mine = true # bool | Returns the list of approvals for the current caller (optional) # bool | Returns the list of approvals for the current caller (optional) + requester_id = '17e633e7d57e481569df76323169deb6a' # str | Returns the list of approvals for a given requester ID (optional) # str | Returns the list of approvals for a given requester ID (optional) + filters = 'filters=status eq PENDING' # 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: **status**: *eq* **referenceType**: *eq* (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: **status**: *eq* **referenceType**: *eq* (optional) + try: + # Get Approvals + + results = ApprovalsApi(api_client).get_approvals(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = ApprovalsApi(api_client).get_approvals(x_sail_point_experimental, mine, requester_id, filters) + print("The response of ApprovalsApi->get_approvals:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ApprovalsApi->get_approvals: %s\n" % e) /generic-approvals/{id}: get: security: @@ -58327,25 +79546,25 @@ paths: application/json: schema: $ref: '#/paths/~1generic-approvals/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/Approval.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Approval.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/approvals#get-approval + label: SDK_tools/sdk/powershell/v2025/methods/approvals#get-approval source: | $Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | ID of the approval that is to be returned $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -58353,14 +79572,38 @@ paths: # Get an approval try { - Get-V2024Approval -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2025Approval -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024Approval -Id $Id -XSailPointExperimental $XSailPointExperimental + # Get-V2025Approval -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Approval" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Approval" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/approvals#get-approval + source: | + from sailpoint.v2025.api.approvals_api import ApprovalsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.approval import Approval + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '38453251-6be2-5f8f-df93-5ce19e295837' # str | ID of the approval that is to be returned # str | ID of the approval that is to be returned + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get an approval + + results = ApprovalsApi(api_client).get_approval(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = ApprovalsApi(api_client).get_approval(id, x_sail_point_experimental) + print("The response of ApprovalsApi->get_approval:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ApprovalsApi->get_approval: %s\n" % e) /machine-accounts: get: operationId: listMachineAccounts @@ -58377,12 +79620,12 @@ paths: - SOURCE_SUBADMIN - HELPDESK parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - in: query name: filters required: false @@ -58402,19 +79645,35 @@ paths: **machineIdentity**: *eq, in, sw* + **description**: *eq, in, sw* + + **ownerIdentity**: *eq, in, sw* + + **ownerIdentityId**: *eq, in, sw* + **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* + **environment**: *eq, in, sw* + **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* - **identity.name**: *eq, in, sw* + **manuallyEdited**: *eq* - **source.name**: *eq, in* + **identity**: *eq, in, sw* + + **source**: *eq, in* + + **hasEntitlement**: *eq* + + **locked**: *eq* + + **connectorAttributes**: *eq* - in: query name: sorters required: false @@ -58444,7 +79703,7 @@ paths: items: allOf: - $ref: '#/components/schemas/Account/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/BaseCommonDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BaseCommonDto.yaml - type: object required: - nativeIdentity @@ -58556,44 +79815,72 @@ paths: name: Active Directory '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/machine-accounts#list-machine-accounts + label: SDK_tools/sdk/powershell/v2025/methods/machine-accounts#list-machine-accounts source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $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) - $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # 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: **id**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **source.name**: *eq, in* (optional) + $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # 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: **id**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **description**: *eq, in, sw* **ownerIdentity**: *eq, in, sw* **ownerIdentityId**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **environment**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **manuallyEdited**: *eq* **identity**: *eq, in, sw* **source**: *eq, in* **hasEntitlement**: *eq* **locked**: *eq* **connectorAttributes**: *eq* (optional) $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (optional) # Machine Accounts List try { - Get-V2024MachineAccounts -XSailPointExperimental $XSailPointExperimental + Get-V2025MachineAccounts -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024MachineAccounts -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + # Get-V2025MachineAccounts -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineAccounts" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MachineAccounts" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/machine-accounts#list-machine-accounts + source: | + from sailpoint.v2025.api.machine_accounts_api import MachineAccountsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.machine_account import MachineAccount + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + filters = 'identityId eq \"2c9180858082150f0180893dbaf44201\"' # 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: **id**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **description**: *eq, in, sw* **ownerIdentity**: *eq, in, sw* **ownerIdentityId**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **environment**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **manuallyEdited**: *eq* **identity**: *eq, in, sw* **source**: *eq, in* **hasEntitlement**: *eq* **locked**: *eq* **connectorAttributes**: *eq* (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: **id**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **description**: *eq, in, sw* **ownerIdentity**: *eq, in, sw* **ownerIdentityId**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **environment**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **manuallyEdited**: *eq* **identity**: *eq, in, sw* **source**: *eq, in* **hasEntitlement**: *eq* **locked**: *eq* **connectorAttributes**: *eq* (optional) + sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (optional) + try: + # Machine Accounts List + + results = MachineAccountsApi(api_client).list_machine_accounts(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = MachineAccountsApi(api_client).list_machine_accounts(x_sail_point_experimental, limit, offset, count, filters, sorters) + print("The response of MachineAccountsApi->list_machine_accounts:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MachineAccountsApi->list_machine_accounts: %s\n" % e) /machine-accounts/{id}: get: operationId: getMachineAccount @@ -58633,28 +79920,28 @@ paths: application/json: schema: $ref: '#/paths/~1machine-accounts/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/MachineAccount.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/MachineAccount.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/machine-accounts#get-machine-account + label: SDK_tools/sdk/powershell/v2025/methods/machine-accounts#get-machine-account source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -58662,14 +79949,38 @@ paths: # Machine Account Details try { - Get-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2025MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental + # Get-V2025MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineAccount" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MachineAccount" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/machine-accounts#get-machine-account + source: | + from sailpoint.v2025.api.machine_accounts_api import MachineAccountsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.machine_account import MachineAccount + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Account ID. # str | Machine Account ID. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Machine Account Details + + results = MachineAccountsApi(api_client).get_machine_account(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = MachineAccountsApi(api_client).get_machine_account(id, x_sail_point_experimental) + print("The response of MachineAccountsApi->get_machine_account:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MachineAccountsApi->get_machine_account: %s\n" % e) patch: operationId: updateMachineAccount tags: @@ -58703,7 +80014,24 @@ paths: required: true requestBody: required: true - description: A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + description: |- + A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: + * description + * ownerIdentity + * subType + * accessType + * environment + * attributes + * classificationMethod + * manuallyEdited + * nativeIdentity + * uuid + * source + * manuallyCorrelated + * enabled + * locked + * hasEntitlements + * connectorAttributes content: application/json-patch+json: schema: @@ -58732,32 +80060,32 @@ paths: application/json: schema: $ref: '#/paths/~1machine-accounts/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/MachineAccount.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/MachineAccount.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/machine-accounts#update-machine-account + label: SDK_tools/sdk/powershell/v2025/methods/machine-accounts#update-machine-account source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes $RequestBody = @"{Add machine identity attribute={value=[{op=add, path=/environment, value=test}]}, Replace machine identity attribute={value=[{op=replace, path=/environment, value=test}]}, Remove machine identity attribute={value=[{op=remove, path=/environment}]}}"@ @@ -58765,14 +80093,39 @@ paths: try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + Update-V2025MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result # Below is a request that includes all optional parameters - # Update-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + # Update-V2025MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024MachineAccount" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025MachineAccount" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/machine-accounts#update-machine-account + source: | + from sailpoint.v2025.api.machine_accounts_api import MachineAccountsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.machine_account import MachineAccount + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Account ID. # str | Machine Account ID. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + request_body = '''{Add machine identity attribute={value=[{op=add, path=/environment, value=test}]}, Replace machine identity attribute={value=[{op=replace, path=/environment, value=test}]}, Remove machine identity attribute={value=[{op=remove, path=/environment}]}}''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes + try: + # Update a Machine Account + new_request_body = RequestBody.from_json(request_body) + results = MachineAccountsApi(api_client).update_machine_account(id=id, x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = MachineAccountsApi(api_client).update_machine_account(id, x_sail_point_experimental, new_request_body) + print("The response of MachineAccountsApi->update_machine_account:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MachineAccountsApi->update_machine_account: %s\n" % e) /machine-identities: get: operationId: listMachineIdentities @@ -58789,6 +80142,30 @@ paths: - SOURCE_SUBADMIN - HELPDESK parameters: + - in: query + name: filters + required: false + schema: + type: string + example: identityId eq "2c9180858082150f0180893dbaf44201" + description: |- + Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) + + Filtering is supported for the following fields and operators: + + **id**: *eq, in, sw* + + **displayName**: *eq, in, sw* + + **cisIdentityId**: *eq, in, sw* + + **description**: *eq, in, sw* + + **businessApplication**: *eq, in, sw* + + **attributes**: *eq* + + **manuallyEdited**: *eq* - in: query name: sorters schema: @@ -58809,11 +80186,11 @@ paths: default: true required: true - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml responses: '200': description: List of machine identities. @@ -58824,7 +80201,7 @@ paths: items: allOf: - $ref: '#/components/schemas/Account/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/BaseCommonDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BaseCommonDto.yaml - type: object title: MachineIdentityDto required: @@ -58849,27 +80226,28 @@ paths: example: '{"Region":"EU"}' '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#list-machine-identities + label: SDK_tools/sdk/powershell/v2025/methods/machine-identities#list-machine-identities source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # 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: **id**: *eq, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* (optional) $Sorters = "businessApplication" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **businessApplication, name** (optional) $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) $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) @@ -58878,14 +80256,42 @@ paths: # List Machine Identities try { - Get-V2024MachineIdentities -XSailPointExperimental $XSailPointExperimental + Get-V2025MachineIdentities -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024MachineIdentities -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Count $Count -Limit $Limit -Offset $Offset + # Get-V2025MachineIdentities -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Sorters $Sorters -Count $Count -Limit $Limit -Offset $Offset } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineIdentities" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MachineIdentities" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/machine-identities#list-machine-identities + source: | + from sailpoint.v2025.api.machine_identities_api import MachineIdentitiesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.machine_identity import MachineIdentity + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + filters = 'identityId eq \"2c9180858082150f0180893dbaf44201\"' # 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: **id**: *eq, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* (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: **id**: *eq, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* (optional) + sorters = 'businessApplication' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **businessApplication, name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **businessApplication, name** (optional) + 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) + 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) + try: + # List Machine Identities + + results = MachineIdentitiesApi(api_client).list_machine_identities(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = MachineIdentitiesApi(api_client).list_machine_identities(x_sail_point_experimental, filters, sorters, count, limit, offset) + print("The response of MachineIdentitiesApi->list_machine_identities:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MachineIdentitiesApi->list_machine_identities: %s\n" % e) post: operationId: createMachineIdentity tags: @@ -58905,7 +80311,7 @@ paths: application/json: schema: $ref: '#/paths/~1machine-identities/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/MachineIdentity.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/MachineIdentity.yaml responses: '200': description: Machine Identity created. @@ -58913,25 +80319,25 @@ paths: application/json: schema: $ref: '#/paths/~1machine-identities/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/MachineIdentity.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/MachineIdentity.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -58943,7 +80349,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#create-machine-identity + label: SDK_tools/sdk/powershell/v2025/methods/machine-identities#create-machine-identity source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $MachineIdentity = @" @@ -58963,14 +80369,47 @@ paths: try { $Result = ConvertFrom-JsonToMachineIdentity -Json $MachineIdentity - New-V2024MachineIdentity -XSailPointExperimental $XSailPointExperimental -MachineIdentity $Result + New-V2025MachineIdentity -XSailPointExperimental $XSailPointExperimental -MachineIdentity $Result # Below is a request that includes all optional parameters - # New-V2024MachineIdentity -XSailPointExperimental $XSailPointExperimental -MachineIdentity $Result + # New-V2025MachineIdentity -XSailPointExperimental $XSailPointExperimental -MachineIdentity $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024MachineIdentity" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025MachineIdentity" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/machine-identities#create-machine-identity + source: | + from sailpoint.v2025.api.machine_identities_api import MachineIdentitiesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.machine_identity import MachineIdentity + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + machine_identity = '''{ + "created" : "2015-05-28T14:07:17Z", + "businessApplication" : "ADService", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "", + "attributes" : "{\"Region\":\"EU\"}", + "id" : "id12345", + "manuallyEdited" : true + }''' # MachineIdentity | + try: + # Create Machine Identities + new_machine_identity = MachineIdentity.from_json(machine_identity) + results = MachineIdentitiesApi(api_client).create_machine_identity(x_sail_point_experimental=x_sail_point_experimental, machine_identity=new_machine_identity) + # Below is a request that includes all optional parameters + # results = MachineIdentitiesApi(api_client).create_machine_identity(x_sail_point_experimental, new_machine_identity) + print("The response of MachineIdentitiesApi->create_machine_identity:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MachineIdentitiesApi->create_machine_identity: %s\n" % e) /machine-identities/{id}: get: operationId: getMachineIdentity @@ -59010,28 +80449,28 @@ paths: application/json: schema: $ref: '#/paths/~1machine-identities/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/MachineIdentity.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/MachineIdentity.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#get-machine-identity + label: SDK_tools/sdk/powershell/v2025/methods/machine-identities#get-machine-identity source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -59039,14 +80478,38 @@ paths: # Machine Identity Details try { - Get-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2025MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + # Get-V2025MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineIdentity" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MachineIdentity" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/machine-identities#get-machine-identity + source: | + from sailpoint.v2025.api.machine_identities_api import MachineIdentitiesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.machine_identity import MachineIdentity + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID # str | Machine Identity ID + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Machine Identity Details + + results = MachineIdentitiesApi(api_client).get_machine_identity(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = MachineIdentitiesApi(api_client).get_machine_identity(id, x_sail_point_experimental) + print("The response of MachineIdentitiesApi->get_machine_identity:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MachineIdentitiesApi->get_machine_identity: %s\n" % e) patch: operationId: updateMachineIdentity tags: @@ -59107,28 +80570,28 @@ paths: application/json: schema: $ref: '#/paths/~1machine-identities/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/MachineIdentity.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/MachineIdentity.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#update-machine-identity + label: SDK_tools/sdk/powershell/v2025/methods/machine-identities#update-machine-identity source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -59140,14 +80603,39 @@ paths: try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + Update-V2025MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result # Below is a request that includes all optional parameters - # Update-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + # Update-V2025MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024MachineIdentity" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025MachineIdentity" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/machine-identities#update-machine-identity + source: | + from sailpoint.v2025.api.machine_identities_api import MachineIdentitiesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.machine_identity import MachineIdentity + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID. # str | Machine Identity ID. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + request_body = '''{Add machine identity attribute={value=[{op=add, path=/attributes/securityRisk, value=medium}]}, Replace machine identity attribute={value=[{op=replace, path=/attributes/securityRisk, value=medium}]}, Remove machine identity attribute={value=[{op=remove, path=/attributes/securityRisk}]}}''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + try: + # Update a Machine Identity + new_request_body = RequestBody.from_json(request_body) + results = MachineIdentitiesApi(api_client).update_machine_identity(id=id, x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = MachineIdentitiesApi(api_client).update_machine_identity(id, x_sail_point_experimental, new_request_body) + print("The response of MachineIdentitiesApi->update_machine_identity:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MachineIdentitiesApi->update_machine_identity: %s\n" % e) delete: operationId: deleteMachineIdentity tags: @@ -59179,28 +80667,28 @@ paths: responses: '204': $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/204.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#delete-machine-identity + label: SDK_tools/sdk/powershell/v2025/methods/machine-identities#delete-machine-identity source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -59208,14 +80696,35 @@ paths: # Delete machine identity try { - Remove-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + Remove-V2025MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Remove-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + # Remove-V2025MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024MachineIdentity" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025MachineIdentity" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/machine-identities#delete-machine-identity + source: | + from sailpoint.v2025.api.machine_identities_api import MachineIdentitiesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID # str | Machine Identity ID + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Delete machine identity + + MachineIdentitiesApi(api_client).delete_machine_identity(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # MachineIdentitiesApi(api_client).delete_machine_identity(id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling MachineIdentitiesApi->delete_machine_identity: %s\n" % e) /notification-template-defaults: get: operationId: listNotificationTemplateDefaults @@ -59227,10 +80736,10 @@ paths: - userAuth: - idn:notification-template-defaults:read parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - in: query name: filters schema: @@ -59453,22 +80962,22 @@ paths: nullable: true '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/notifications#list-notification-template-defaults + label: SDK_tools/sdk/powershell/v2025/methods/notifications#list-notification-template-defaults source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $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) @@ -59478,14 +80987,40 @@ paths: # List Notification Template Defaults try { - Get-V2024NotificationTemplateDefaults -XSailPointExperimental $XSailPointExperimental + Get-V2025NotificationTemplateDefaults -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024NotificationTemplateDefaults -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $Filters + # Get-V2025NotificationTemplateDefaults -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationTemplateDefaults" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NotificationTemplateDefaults" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/notifications#list-notification-template-defaults + source: | + from sailpoint.v2025.api.notifications_api import NotificationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.template_dto_default import TemplateDtoDefault + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + filters = 'key eq \"cloud_manual_work_item_summary\"' # 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + try: + # List Notification Template Defaults + + results = NotificationsApi(api_client).list_notification_template_defaults(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).list_notification_template_defaults(x_sail_point_experimental, limit, offset, filters) + print("The response of NotificationsApi->list_notification_template_defaults:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NotificationsApi->list_notification_template_defaults: %s\n" % e) /notification-templates: get: operationId: listNotificationTemplates @@ -59497,10 +81032,10 @@ paths: - userAuth: - idn:notification-templates:read parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - in: query name: filters schema: @@ -59614,22 +81149,22 @@ paths: - locale '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/notifications#list-notification-templates + label: SDK_tools/sdk/powershell/v2025/methods/notifications#list-notification-templates source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $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) @@ -59639,14 +81174,40 @@ paths: # List Notification Templates try { - Get-V2024NotificationTemplates -XSailPointExperimental $XSailPointExperimental + Get-V2025NotificationTemplates -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024NotificationTemplates -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $Filters + # Get-V2025NotificationTemplates -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationTemplates" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NotificationTemplates" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/notifications#list-notification-templates + source: | + from sailpoint.v2025.api.notifications_api import NotificationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.template_dto import TemplateDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + filters = 'medium eq \"EMAIL\"' # 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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (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: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + try: + # List Notification Templates + + results = NotificationsApi(api_client).list_notification_templates(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).list_notification_templates(x_sail_point_experimental, limit, offset, filters) + print("The response of NotificationsApi->list_notification_templates:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NotificationsApi->list_notification_templates: %s\n" % e) post: operationId: createNotificationTemplate tags: @@ -59665,7 +81226,7 @@ paths: application/json: schema: $ref: '#/paths/~1notification-templates/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/TemplateDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TemplateDto.yaml responses: '200': description: A template object for your site @@ -59673,22 +81234,22 @@ paths: application/json: schema: $ref: '#/paths/~1notification-templates/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/TemplateDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TemplateDto.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -59700,7 +81261,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/notifications#create-notification-template + label: SDK_tools/sdk/powershell/v2025/methods/notifications#create-notification-template source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $TemplateDto = @" @@ -59728,14 +81289,55 @@ paths: try { $Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto - New-V2024NotificationTemplate -XSailPointExperimental $XSailPointExperimental -TemplateDto $Result + New-V2025NotificationTemplate -XSailPointExperimental $XSailPointExperimental -TemplateDto $Result # Below is a request that includes all optional parameters - # New-V2024NotificationTemplate -XSailPointExperimental $XSailPointExperimental -TemplateDto $Result + # New-V2025NotificationTemplate -XSailPointExperimental $XSailPointExperimental -TemplateDto $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NotificationTemplate" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025NotificationTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/notifications#create-notification-template + source: | + from sailpoint.v2025.api.notifications_api import NotificationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.template_dto import TemplateDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + template_dto = '''{ + "slackTemplate" : "slackTemplate", + "footer" : "footer", + "teamsTemplate" : "teamsTemplate", + "subject" : "You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.", + "created" : "2020-01-01T00:00:00Z", + "description" : "Daily digest - sent if number of outstanding tasks for task owner > 0", + "medium" : "EMAIL", + "locale" : "en", + "body" : "Please go to the task manager", + "name" : "Task Manager Subscription", + "replyTo" : "$__global.emailFromAddress", + "header" : "header", + "modified" : "2020-01-01T00:00:00Z", + "from" : "$__global.emailFromAddress", + "id" : "c17bea3a-574d-453c-9e04-4365fbf5af0b", + "key" : "cloud_manual_work_item_summary" + }''' # TemplateDto | + try: + # Create Notification Template + new_template_dto = TemplateDto.from_json(template_dto) + results = NotificationsApi(api_client).create_notification_template(x_sail_point_experimental=x_sail_point_experimental, template_dto=new_template_dto) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).create_notification_template(x_sail_point_experimental, new_template_dto) + print("The response of NotificationsApi->create_notification_template:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NotificationsApi->create_notification_template: %s\n" % e) /notification-templates/{id}: get: operationId: getNotificationTemplate @@ -59768,28 +81370,26 @@ paths: content: application/json: schema: - type: array - items: - $ref: '#/paths/~1notification-templates/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/TemplateDto.yaml + $ref: '#/paths/~1notification-templates/get/responses/200/content/application~1json/schema/items' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TemplateDto.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/notifications#get-notification-template + label: SDK_tools/sdk/powershell/v2025/methods/notifications#get-notification-template source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Notification Template $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -59797,14 +81397,38 @@ paths: # Get Notification Template By Id try { - Get-V2024NotificationTemplate -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2025NotificationTemplate -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024NotificationTemplate -Id $Id -XSailPointExperimental $XSailPointExperimental + # Get-V2025NotificationTemplate -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationTemplate" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NotificationTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/notifications#get-notification-template + source: | + from sailpoint.v2025.api.notifications_api import NotificationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.template_dto import TemplateDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Notification Template # str | Id of the Notification Template + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get Notification Template By Id + + results = NotificationsApi(api_client).get_notification_template(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).get_notification_template(id, x_sail_point_experimental) + print("The response of NotificationsApi->get_notification_template:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NotificationsApi->get_notification_template: %s\n" % e) /notification-templates/bulk-delete: post: operationId: deleteNotificationTemplatesInBulk @@ -59843,22 +81467,22 @@ paths: responses: '204': $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/204.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -59870,7 +81494,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/notifications#delete-notification-templates-in-bulk + label: SDK_tools/sdk/powershell/v2025/methods/notifications#delete-notification-templates-in-bulk source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $TemplateBulkDeleteDto = @"{ @@ -59884,14 +81508,36 @@ paths: try { $Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto - Remove-V2024NotificationTemplatesInBulk -XSailPointExperimental $XSailPointExperimental -TemplateBulkDeleteDto $Result + Remove-V2025NotificationTemplatesInBulk -XSailPointExperimental $XSailPointExperimental -TemplateBulkDeleteDto $Result # Below is a request that includes all optional parameters - # Remove-V2024NotificationTemplatesInBulk -XSailPointExperimental $XSailPointExperimental -TemplateBulkDeleteDto $Result + # Remove-V2025NotificationTemplatesInBulk -XSailPointExperimental $XSailPointExperimental -TemplateBulkDeleteDto $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NotificationTemplatesInBulk" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025NotificationTemplatesInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/notifications#delete-notification-templates-in-bulk + source: | + from sailpoint.v2025.api.notifications_api import NotificationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.template_bulk_delete_dto import TemplateBulkDeleteDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + template_bulk_delete_dto = '''[sailpoint.v2025.TemplateBulkDeleteDto()]''' # List[TemplateBulkDeleteDto] | + try: + # Bulk Delete Notification Templates + new_template_bulk_delete_dto = TemplateBulkDeleteDto.from_json(template_bulk_delete_dto) + NotificationsApi(api_client).delete_notification_templates_in_bulk(x_sail_point_experimental=x_sail_point_experimental, template_bulk_delete_dto=new_template_bulk_delete_dto) + # Below is a request that includes all optional parameters + # NotificationsApi(api_client).delete_notification_templates_in_bulk(x_sail_point_experimental, new_template_bulk_delete_dto) + except Exception as e: + print("Exception when calling NotificationsApi->delete_notification_templates_in_bulk: %s\n" % e) /org-config: get: operationId: getOrgConfig @@ -59989,22 +81635,22 @@ paths: example: 2 '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -60016,21 +81662,44 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/org-config#get-org-config + label: SDK_tools/sdk/powershell/v2025/methods/org-config#get-org-config source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Get Org Config Settings try { - Get-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental + Get-V2025OrgConfig -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental + # Get-V2025OrgConfig -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OrgConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025OrgConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/org-config#get-org-config + source: | + from sailpoint.v2025.api.org_config_api import OrgConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.org_config import OrgConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get Org Config Settings + + results = OrgConfigApi(api_client).get_org_config(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = OrgConfigApi(api_client).get_org_config(x_sail_point_experimental) + print("The response of OrgConfigApi->get_org_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling OrgConfigApi->get_org_config: %s\n" % e) patch: operationId: patchOrgConfig tags: @@ -60050,7 +81719,7 @@ paths: type: array items: $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/JsonPatchOperation.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml example: - op: replace path: /timeZone @@ -60063,25 +81732,25 @@ paths: application/json: schema: $ref: '#/paths/~1org-config/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/OrgConfig.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/OrgConfig.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -60093,7 +81762,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/org-config#patch-org-config + label: SDK_tools/sdk/powershell/v2025/methods/org-config#patch-org-config source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $JsonPatchOperation = @"{ @@ -60107,14 +81776,39 @@ paths: try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + Update-V2025OrgConfig -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + # Update-V2025OrgConfig -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024OrgConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025OrgConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/org-config#patch-org-config + source: | + from sailpoint.v2025.api.org_config_api import OrgConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2025.models.org_config import OrgConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch_operation = '''[{op=replace, path=/timeZone, value=America/Toronto}]''' # List[JsonPatchOperation] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + try: + # Patch Org Config + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = OrgConfigApi(api_client).patch_org_config(x_sail_point_experimental=x_sail_point_experimental, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = OrgConfigApi(api_client).patch_org_config(x_sail_point_experimental, new_json_patch_operation) + print("The response of OrgConfigApi->patch_org_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling OrgConfigApi->patch_org_config: %s\n" % e) /org-config/valid-time-zones: get: operationId: getValidTimeZones @@ -60148,19 +81842,19 @@ paths: - Europe/Kiev '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -60170,15 +81864,15 @@ paths: type: string default: true required: true - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit50.yaml + - $ref: '#/paths/~1connector-rules/get/parameters/0' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit50.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/org-config#get-valid-time-zones + label: SDK_tools/sdk/powershell/v2025/methods/org-config#get-valid-time-zones source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) @@ -60188,14 +81882,39 @@ paths: # Get Valid Time Zones try { - Get-V2024ValidTimeZones -XSailPointExperimental $XSailPointExperimental + Get-V2025ValidTimeZones -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024ValidTimeZones -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count + # Get-V2025ValidTimeZones -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ValidTimeZones" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ValidTimeZones" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/org-config#get-valid-time-zones + source: | + from sailpoint.v2025.api.org_config_api import OrgConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + 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: + # Get Valid Time Zones + + results = OrgConfigApi(api_client).get_valid_time_zones(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = OrgConfigApi(api_client).get_valid_time_zones(x_sail_point_experimental, limit, offset, count) + print("The response of OrgConfigApi->get_valid_time_zones:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling OrgConfigApi->get_valid_time_zones: %s\n" % e) /outlier-summaries: get: operationId: getIdentityOutlierSnapshots @@ -60204,10 +81923,10 @@ paths: summary: IAI Identity Outliers Summary description: This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - name: type in: query description: Type of the identity outliers snapshot to filter on @@ -60290,22 +82009,22 @@ paths: example: 0 '202': $ref: '#/paths/~1access-requests~1cancel/post/responses/202' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/202.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/202.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - iai:outliers:read @@ -60318,7 +82037,7 @@ paths: - REPORT_ADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-outliers#get-identity-outlier-snapshots + label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#get-identity-outlier-snapshots source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $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) @@ -60330,14 +82049,42 @@ paths: # IAI Identity Outliers Summary try { - Get-V2024IdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental + Get-V2025IdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024IdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Type $Type -Filters $Filters -Sorters $Sorters + # Get-V2025IdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Type $Type -Filters $Filters -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityOutlierSnapshots" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityOutlierSnapshots" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-outliers#get-identity-outlier-snapshots + source: | + from sailpoint.v2025.api.iai_outliers_api import IAIOutliersApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.outlier_summary import OutlierSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + type = 'LOW_SIMILARITY' # str | Type of the identity outliers snapshot to filter on (optional) # str | Type of the identity outliers snapshot to filter on (optional) + filters = 'snapshotDate ge \"2022-02-07T20:13:29.356648026Z\"' # 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: **snapshotDate**: *ge, le* (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: **snapshotDate**: *ge, le* (optional) + sorters = 'snapshotDate' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **snapshotDate** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **snapshotDate** (optional) + try: + # IAI Identity Outliers Summary + + results = IAIOutliersApi(api_client).get_identity_outlier_snapshots(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIOutliersApi(api_client).get_identity_outlier_snapshots(x_sail_point_experimental, limit, offset, type, filters, sorters) + print("The response of IAIOutliersApi->get_identity_outlier_snapshots:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_identity_outlier_snapshots: %s\n" % e) /outlier-summaries/latest: get: operationId: getLatestIdentityOutlierSnapshots @@ -60400,22 +82147,22 @@ paths: example: 10 '202': $ref: '#/paths/~1access-requests~1cancel/post/responses/202' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/202.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/202.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - iai:outliers:read @@ -60428,7 +82175,7 @@ paths: - REPORT_ADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-outliers#get-latest-identity-outlier-snapshots + label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#get-latest-identity-outlier-snapshots source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) @@ -60436,14 +82183,38 @@ paths: # IAI Identity Outliers Latest Summary try { - Get-V2024LatestIdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental + Get-V2025LatestIdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024LatestIdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental -Type $Type + # Get-V2025LatestIdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental -Type $Type } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024LatestIdentityOutlierSnapshots" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025LatestIdentityOutlierSnapshots" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-outliers#get-latest-identity-outlier-snapshots + source: | + from sailpoint.v2025.api.iai_outliers_api import IAIOutliersApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.latest_outlier_summary import LatestOutlierSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + type = 'LOW_SIMILARITY' # str | Type of the identity outliers snapshot to filter on (optional) # str | Type of the identity outliers snapshot to filter on (optional) + try: + # IAI Identity Outliers Latest Summary + + results = IAIOutliersApi(api_client).get_latest_identity_outlier_snapshots(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIOutliersApi(api_client).get_latest_identity_outlier_snapshots(x_sail_point_experimental, type) + print("The response of IAIOutliersApi->get_latest_identity_outlier_snapshots:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_latest_identity_outlier_snapshots: %s\n" % e) /outliers: get: operationId: getIdentityOutliers @@ -60452,12 +82223,12 @@ paths: summary: IAI Get Identity Outliers description: This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information. parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - name: type in: query description: Type of the identity outliers snapshot to filter on @@ -60586,19 +82357,19 @@ paths: nullable: true '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - iai:outliers:read @@ -60611,7 +82382,7 @@ paths: - REPORT_ADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-outliers#get-identity-outliers + label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#get-identity-outliers source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $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) @@ -60624,14 +82395,43 @@ paths: # IAI Get Identity Outliers try { - Get-V2024IdentityOutliers -XSailPointExperimental $XSailPointExperimental + Get-V2025IdentityOutliers -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024IdentityOutliers -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Type $Type -Filters $Filters -Sorters $Sorters + # Get-V2025IdentityOutliers -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Type $Type -Filters $Filters -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityOutliers" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityOutliers" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-outliers#get-identity-outliers + source: | + from sailpoint.v2025.api.iai_outliers_api import IAIOutliersApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.outlier import Outlier + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + type = 'LOW_SIMILARITY' # str | Type of the identity outliers snapshot to filter on (optional) # str | Type of the identity outliers snapshot to filter on (optional) + filters = 'attributes.displayName sw \"John\" and certStatus eq \"false\"' # 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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (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: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (optional) + sorters = 'attributes.displayName,firstDetectionDate,-score' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **firstDetectionDate, attributes, score** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **firstDetectionDate, attributes, score** (optional) + try: + # IAI Get Identity Outliers + + results = IAIOutliersApi(api_client).get_identity_outliers(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIOutliersApi(api_client).get_identity_outliers(x_sail_point_experimental, limit, offset, count, type, filters, sorters) + print("The response of IAIOutliersApi->get_identity_outliers:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_identity_outliers: %s\n" % e) /outliers/{outlierId}/contributing-features: get: operationId: getPeerGroupOutliersContributingFeatures @@ -60643,12 +82443,12 @@ paths: The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object. parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - name: include-translation-messages in: query description: Whether or not to include translation messages object in returned response @@ -60711,28 +82511,33 @@ paths: description: The name of the feature example: entitlement_count valueType: - type: string - enum: - - INTEGER - - FLOAT + type: object description: The data type of the value field - example: INTEGER - value: - oneOf: - - type: number - format: float + properties: + name: + type: string + enum: + - INTEGER + - FLOAT + description: The data type of the value field + example: INTEGER + ordinal: + description: The position of the value type + type: integer + format: int32 minimum: 0 maximum: 1 - - type: integer - format: int64 + example: 0 + value: + type: number + format: float + minimum: 0 description: The feature value - example: 0.92 + example: 1 importance: type: number format: float description: The importance of the feature. This can also be a negative value - minimum: -1 - maximum: 1 example: -0.15 displayName: type: string @@ -60744,31 +82549,32 @@ paths: example: The total number of entitlements belonging to an identity translationMessages: type: object + nullable: true properties: displayName: $ref: '#/paths/~1ai-access-request-recommendations/get/responses/200/content/application~1json/schema/items/properties/translationMessages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/TranslationMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TranslationMessage.yaml description: $ref: '#/paths/~1ai-access-request-recommendations/get/responses/200/content/application~1json/schema/items/properties/translationMessages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/TranslationMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TranslationMessage.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - iai:outliers:read @@ -60781,7 +82587,7 @@ paths: - REPORT_ADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-outliers#get-peer-group-outliers-contributing-features + label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#get-peer-group-outliers-contributing-features source: | $OutlierId = "2c918085842e69ae018432d22ccb212f" # String | The outlier id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -60794,14 +82600,43 @@ paths: # Get identity outlier's contibuting features try { - Get-V2024PeerGroupOutliersContributingFeatures -OutlierId $OutlierId -XSailPointExperimental $XSailPointExperimental + Get-V2025PeerGroupOutliersContributingFeatures -OutlierId $OutlierId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024PeerGroupOutliersContributingFeatures -OutlierId $OutlierId -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -IncludeTranslationMessages $IncludeTranslationMessages -Sorters $Sorters + # Get-V2025PeerGroupOutliersContributingFeatures -OutlierId $OutlierId -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -IncludeTranslationMessages $IncludeTranslationMessages -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PeerGroupOutliersContributingFeatures" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PeerGroupOutliersContributingFeatures" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-outliers#get-peer-group-outliers-contributing-features + source: | + from sailpoint.v2025.api.iai_outliers_api import IAIOutliersApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.outlier_contributing_feature import OutlierContributingFeature + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + outlier_id = '2c918085842e69ae018432d22ccb212f' # str | The outlier id # str | The outlier id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + include_translation_messages = 'include-translation-messages=' # str | Whether or not to include translation messages object in returned response (optional) # str | Whether or not to include translation messages object in returned response (optional) + sorters = 'importance' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **importance** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **importance** (optional) + try: + # Get identity outlier's contibuting features + + results = IAIOutliersApi(api_client).get_peer_group_outliers_contributing_features(outlier_id=outlier_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIOutliersApi(api_client).get_peer_group_outliers_contributing_features(outlier_id, x_sail_point_experimental, limit, offset, count, include_translation_messages, sorters) + print("The response of IAIOutliersApi->get_peer_group_outliers_contributing_features:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_peer_group_outliers_contributing_features: %s\n" % e) /outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items: get: operationId: listOutliersContributingFeatureAccessItems @@ -60813,12 +82648,12 @@ paths: The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare. parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - in: path name: outlierId schema: @@ -60888,6 +82723,7 @@ paths: description: type: string description: Description of the access item. + nullable: true example: Access to research information, lab results, and schematics accessType: type: string @@ -60908,22 +82744,22 @@ paths: description: rarest access '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - iai:outliers:read @@ -60936,7 +82772,7 @@ paths: - REPORT_ADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-outliers#list-outliers-contributing-feature-access-items + label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#list-outliers-contributing-feature-access-items source: | $OutlierId = "2c918085842e69ae018432d22ccb212f" # String | The outlier id $ContributingFeatureName = "radical_entitlement_count" # String | The name of contributing feature @@ -60950,14 +82786,44 @@ paths: # Gets a list of access items associated with each identity outlier contributing feature try { - Get-V2024OutliersContributingFeatureAccessItems -OutlierId $OutlierId -ContributingFeatureName $ContributingFeatureName -XSailPointExperimental $XSailPointExperimental + Get-V2025OutliersContributingFeatureAccessItems -OutlierId $OutlierId -ContributingFeatureName $ContributingFeatureName -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024OutliersContributingFeatureAccessItems -OutlierId $OutlierId -ContributingFeatureName $ContributingFeatureName -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -AccessType $AccessType -Sorters $Sorters + # Get-V2025OutliersContributingFeatureAccessItems -OutlierId $OutlierId -ContributingFeatureName $ContributingFeatureName -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -AccessType $AccessType -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OutliersContributingFeatureAccessItems" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025OutliersContributingFeatureAccessItems" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-outliers#list-outliers-contributing-feature-access-items + source: | + from sailpoint.v2025.api.iai_outliers_api import IAIOutliersApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.outliers_contributing_feature_access_items import OutliersContributingFeatureAccessItems + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + outlier_id = '2c918085842e69ae018432d22ccb212f' # str | The outlier id # str | The outlier id + contributing_feature_name = 'entitlement_count' # str | The name of contributing feature # str | The name of contributing feature + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + access_type = 'ENTITLEMENT' # str | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) # str | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) + sorters = 'displayName' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName** (optional) + try: + # Gets a list of access items associated with each identity outlier contributing feature + + results = IAIOutliersApi(api_client).list_outliers_contributing_feature_access_items(outlier_id=outlier_id, contributing_feature_name=contributing_feature_name, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIOutliersApi(api_client).list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, x_sail_point_experimental, limit, offset, count, access_type, sorters) + print("The response of IAIOutliersApi->list_outliers_contributing_feature_access_items:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIOutliersApi->list_outliers_contributing_feature_access_items: %s\n" % e) /outliers/ignore: post: operationId: ignoreIdentityOutliers @@ -60980,22 +82846,22 @@ paths: responses: '204': $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/204.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -61015,7 +82881,7 @@ paths: - REPORT_ADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-outliers#ignore-identity-outliers + label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#ignore-identity-outliers source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $RequestBody = "MyRequestBody" # String[] | @@ -61026,14 +82892,35 @@ paths: try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Invoke-V2024IgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + Invoke-V2025IgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result # Below is a request that includes all optional parameters - # Invoke-V2024IgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + # Invoke-V2025IgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024IgnoreIdentityOutliers" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025IgnoreIdentityOutliers" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-outliers#ignore-identity-outliers + source: | + from sailpoint.v2025.api.iai_outliers_api import IAIOutliersApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + request_body = '''['request_body_example']''' # List[str] | + try: + # IAI Identity Outliers Ignore + new_request_body = RequestBody.from_json(request_body) + IAIOutliersApi(api_client).ignore_identity_outliers(x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body) + # Below is a request that includes all optional parameters + # IAIOutliersApi(api_client).ignore_identity_outliers(x_sail_point_experimental, new_request_body) + except Exception as e: + print("Exception when calling IAIOutliersApi->ignore_identity_outliers: %s\n" % e) /outliers/unignore: post: operationId: unIgnoreIdentityOutliers @@ -61056,22 +82943,22 @@ paths: responses: '204': $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/204.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -61091,7 +82978,7 @@ paths: - REPORT_ADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-outliers#un-ignore-identity-outliers + label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#un-ignore-identity-outliers source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $RequestBody = "MyRequestBody" # String[] | @@ -61102,14 +82989,35 @@ paths: try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Invoke-V2024UnIgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + Invoke-V2025UnIgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result # Below is a request that includes all optional parameters - # Invoke-V2024UnIgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + # Invoke-V2025UnIgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024UnIgnoreIdentityOutliers" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025UnIgnoreIdentityOutliers" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-outliers#un-ignore-identity-outliers + source: | + from sailpoint.v2025.api.iai_outliers_api import IAIOutliersApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + request_body = '''['request_body_example']''' # List[str] | + try: + # IAI Identity Outliers Unignore + new_request_body = RequestBody.from_json(request_body) + IAIOutliersApi(api_client).un_ignore_identity_outliers(x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body) + # Below is a request that includes all optional parameters + # IAIOutliersApi(api_client).un_ignore_identity_outliers(x_sail_point_experimental, new_request_body) + except Exception as e: + print("Exception when calling IAIOutliersApi->un_ignore_identity_outliers: %s\n" % e) /outliers/export: get: operationId: exportOutliersZip @@ -61149,19 +83057,19 @@ paths: format: binary '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - iai:outliers:read @@ -61174,7 +83082,7 @@ paths: - REPORT_ADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-outliers#export-outliers-zip + label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#export-outliers-zip source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) @@ -61182,14 +83090,37 @@ paths: # IAI Identity Outliers Export try { - Export-V2024OutliersZip -XSailPointExperimental $XSailPointExperimental + Export-V2025OutliersZip -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Export-V2024OutliersZip -XSailPointExperimental $XSailPointExperimental -Type $Type + # Export-V2025OutliersZip -XSailPointExperimental $XSailPointExperimental -Type $Type } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024OutliersZip" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025OutliersZip" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-outliers#export-outliers-zip + source: | + from sailpoint.v2025.api.iai_outliers_api import IAIOutliersApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + type = 'LOW_SIMILARITY' # str | Type of the identity outliers snapshot to filter on (optional) # str | Type of the identity outliers snapshot to filter on (optional) + try: + # IAI Identity Outliers Export + + results = IAIOutliersApi(api_client).export_outliers_zip(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIOutliersApi(api_client).export_outliers_zip(x_sail_point_experimental, type) + print("The response of IAIOutliersApi->export_outliers_zip:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIOutliersApi->export_outliers_zip: %s\n" % e) /outlier-feature-summaries/{outlierFeatureId}: get: operationId: getOutlierContributingFeatureSummary @@ -61252,12 +83183,8 @@ paths: example: 55 description: value valueType: - type: string - enum: - - INTEGER - - FLOAT - description: The data type of the value field - example: INTEGER + $ref: '#/paths/~1outliers~1%7BoutlierId%7D~1contributing-features/get/responses/200/content/application~1json/schema/items/properties/valueType' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/OutlierValueType featureDefinition: type: string description: Definition of the feature @@ -61268,10 +83195,12 @@ paths: example: An identity that has too much rare access has a higher change of becoming a security threat due to the unique access they possess peerDisplayName: type: string + nullable: true description: outlier's peer identity display name example: Mary Jane peerIdentityId: type: string + nullable: true description: outlier's peer identity id example: 9f9d5d53ad0e48fba7352f6da9f1b8gbg accessItemReference: @@ -61282,22 +83211,22 @@ paths: searchPlaceholder: Search by name or description '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - iai:outliers:read @@ -61310,7 +83239,7 @@ paths: - REPORT_ADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-outliers#get-outlier-contributing-feature-summary + label: SDK_tools/sdk/powershell/v2025/methods/iai-outliers#get-outlier-contributing-feature-summary source: | $OutlierFeatureId = "04654b66-7561-4090-94f9-abee0722a1af" # String | Contributing feature id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -61318,14 +83247,38 @@ paths: # Get identity outlier contibuting feature summary try { - Get-V2024OutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId -XSailPointExperimental $XSailPointExperimental + Get-V2025OutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024OutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId -XSailPointExperimental $XSailPointExperimental + # Get-V2025OutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OutlierContributingFeatureSummary" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025OutlierContributingFeatureSummary" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-outliers#get-outlier-contributing-feature-summary + source: | + from sailpoint.v2025.api.iai_outliers_api import IAIOutliersApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.outlier_feature_summary import OutlierFeatureSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + outlier_feature_id = '04654b66-7561-4090-94f9-abee0722a1af' # str | Contributing feature id # str | Contributing feature id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get identity outlier contibuting feature summary + + results = IAIOutliersApi(api_client).get_outlier_contributing_feature_summary(outlier_feature_id=outlier_feature_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIOutliersApi(api_client).get_outlier_contributing_feature_summary(outlier_feature_id, x_sail_point_experimental) + print("The response of IAIOutliersApi->get_outlier_contributing_feature_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIOutliersApi->get_outlier_contributing_feature_summary: %s\n" % e) /peer-group-strategies/{strategy}/identity-outliers: get: operationId: getPeerGroupOutliers @@ -61344,12 +83297,12 @@ paths: required: true description: The strategy used to create peer groups. Currently, 'entitlement' is supported. example: entitlement - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - name: X-SailPoint-Experimental in: header description: Use this header to enable this experimental API. @@ -61384,24 +83337,24 @@ paths: description: Arbitrary key-value pairs, belonging to the peer group member. '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: [] x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-peer-group-strategies#get-peer-group-outliers + label: SDK_tools/sdk/powershell/v2025/methods/iai-peer-group-strategies#get-peer-group-outliers source: | $Strategy = "entitlement" # String | The strategy used to create peer groups. Currently, 'entitlement' is supported. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -61412,14 +83365,41 @@ paths: # Identity Outliers List try { - Get-V2024PeerGroupOutliers -Strategy $Strategy -XSailPointExperimental $XSailPointExperimental + Get-V2025PeerGroupOutliers -Strategy $Strategy -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024PeerGroupOutliers -Strategy $Strategy -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count + # Get-V2025PeerGroupOutliers -Strategy $Strategy -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PeerGroupOutliers" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PeerGroupOutliers" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-peer-group-strategies#get-peer-group-outliers + source: | + from sailpoint.v2025.api.iai_peer_group_strategies_api import IAIPeerGroupStrategiesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.peer_group_member import PeerGroupMember + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + strategy = 'entitlement' # str | The strategy used to create peer groups. Currently, 'entitlement' is supported. # str | The strategy used to create peer groups. Currently, 'entitlement' is supported. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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: + # Identity Outliers List + + results = IAIPeerGroupStrategiesApi(api_client).get_peer_group_outliers(strategy=strategy, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIPeerGroupStrategiesApi(api_client).get_peer_group_outliers(strategy, x_sail_point_experimental, limit, offset, count) + print("The response of IAIPeerGroupStrategiesApi->get_peer_group_outliers:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIPeerGroupStrategiesApi->get_peer_group_outliers: %s\n" % e) /notification-template-context: get: operationId: getNotificationsTemplateContext @@ -61468,19 +83448,19 @@ paths: example: '2020-04-15T16:16:47.525Z' '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -61492,21 +83472,44 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/notifications#get-notifications-template-context + label: SDK_tools/sdk/powershell/v2025/methods/notifications#get-notifications-template-context source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Get Notification Template Context try { - Get-V2024NotificationsTemplateContext -XSailPointExperimental $XSailPointExperimental + Get-V2025NotificationsTemplateContext -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024NotificationsTemplateContext -XSailPointExperimental $XSailPointExperimental + # Get-V2025NotificationsTemplateContext -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationsTemplateContext" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NotificationsTemplateContext" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/notifications#get-notifications-template-context + source: | + from sailpoint.v2025.api.notifications_api import NotificationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.notification_template_context import NotificationTemplateContext + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get Notification Template Context + + results = NotificationsApi(api_client).get_notifications_template_context(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).get_notifications_template_context(x_sail_point_experimental) + print("The response of NotificationsApi->get_notifications_template_context:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NotificationsApi->get_notifications_template_context: %s\n" % e) /notification-preferences/{key}: get: operationId: listNotificationPreferences @@ -61523,51 +83526,49 @@ paths: content: application/json: schema: - type: array - items: - type: object - description: Maps an Identity's attribute key to a list of preferred notification mediums. - properties: - key: + type: object + description: Maps an Identity's attribute key to a list of preferred notification mediums. + properties: + key: + type: string + description: The template notification key. + example: cloud_manual_work_item_summary + mediums: + type: array + description: List of preferred notification mediums, i.e., the mediums (or method) for which notifications are enabled. More mediums may be added in the future. + items: type: string - description: The template notification key. - example: cloud_manual_work_item_summary - mediums: - type: array - description: List of preferred notification mediums, i.e., the mediums (or method) for which notifications are enabled. More mediums may be added in the future. - items: - type: string - enum: - - EMAIL - - SMS - - PHONE - - SLACK - - TEAMS - example: + enum: - EMAIL - modified: - type: string - description: Modified date of preference - format: date-time - example: '2020-05-15T14:37:06.909Z' + - SMS + - PHONE + - SLACK + - TEAMS + example: + - EMAIL + modified: + type: string + description: Modified date of preference + format: date-time + example: '2020-05-15T14:37:06.909Z' '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -61579,21 +83580,44 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/notifications#list-notification-preferences + label: SDK_tools/sdk/powershell/v2025/methods/notifications#list-notification-preferences source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # List Notification Preferences for tenant. try { - Get-V2024NotificationPreferences -XSailPointExperimental $XSailPointExperimental + Get-V2025NotificationPreferences -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024NotificationPreferences -XSailPointExperimental $XSailPointExperimental + # Get-V2025NotificationPreferences -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationPreferences" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NotificationPreferences" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/notifications#list-notification-preferences + source: | + from sailpoint.v2025.api.notifications_api import NotificationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.preferences_dto import PreferencesDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # List Notification Preferences for tenant. + + results = NotificationsApi(api_client).list_notification_preferences(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).list_notification_preferences(x_sail_point_experimental) + print("The response of NotificationsApi->list_notification_preferences:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NotificationsApi->list_notification_preferences: %s\n" % e) /reassignment-configurations/types: get: operationId: getReassignmentConfigTypes @@ -61628,7 +83652,7 @@ paths: example: accessRequests internalNameCamel: $ref: '#/paths/~1reassignment-configurations~1%7BidentityId%7D~1%7BconfigType%7D/delete/parameters/1/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/work-reassignment/ConfigTypeEnum.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/work-reassignment/ConfigTypeEnum.yaml displayName: type: string description: Human readable display name of the type to be shown on UI @@ -61639,19 +83663,19 @@ paths: example: Reassign Access Request Work Items for an identity '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -61663,21 +83687,44 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#get-reassignment-config-types + label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#get-reassignment-config-types source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # List Reassignment Config Types try { - Get-V2024ReassignmentConfigTypes -XSailPointExperimental $XSailPointExperimental + Get-V2025ReassignmentConfigTypes -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024ReassignmentConfigTypes -XSailPointExperimental $XSailPointExperimental + # Get-V2025ReassignmentConfigTypes -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfigTypes" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ReassignmentConfigTypes" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-reassignment#get-reassignment-config-types + source: | + from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.config_type import ConfigType + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # List Reassignment Config Types + + results = WorkReassignmentApi(api_client).get_reassignment_config_types(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).get_reassignment_config_types(x_sail_point_experimental) + print("The response of WorkReassignmentApi->get_reassignment_config_types:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_reassignment_config_types: %s\n" % e) /reassignment-configurations: get: operationId: listReassignmentConfigurations @@ -61720,10 +83767,10 @@ paths: properties: configType: $ref: '#/paths/~1reassignment-configurations~1%7BidentityId%7D~1%7BconfigType%7D/delete/parameters/1/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/work-reassignment/ConfigTypeEnum.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/work-reassignment/ConfigTypeEnum.yaml targetIdentity: $ref: '#/paths/~1reassignment-configurations/get/responses/200/content/application~1json/schema/items/properties/identity' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/work-reassignment/Identity.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/work-reassignment/Identity.yaml startDate: type: string description: The date from which to start reassigning work items @@ -61736,25 +83783,25 @@ paths: example: '0001-01-01T00:00:00Z' auditDetails: $ref: '#/paths/~1reassignment-configurations~1tenant-config/get/responses/200/content/application~1json/schema/properties/auditDetails' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/work-reassignment/AuditDetails.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/work-reassignment/AuditDetails.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -61766,21 +83813,44 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#list-reassignment-configurations + label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#list-reassignment-configurations source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # List Reassignment Configurations try { - Get-V2024ReassignmentConfigurations -XSailPointExperimental $XSailPointExperimental + Get-V2025ReassignmentConfigurations -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024ReassignmentConfigurations -XSailPointExperimental $XSailPointExperimental + # Get-V2025ReassignmentConfigurations -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfigurations" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ReassignmentConfigurations" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-reassignment#list-reassignment-configurations + source: | + from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.configuration_response import ConfigurationResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # List Reassignment Configurations + + results = WorkReassignmentApi(api_client).list_reassignment_configurations(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).list_reassignment_configurations(x_sail_point_experimental) + print("The response of WorkReassignmentApi->list_reassignment_configurations:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkReassignmentApi->list_reassignment_configurations: %s\n" % e) post: operationId: createReassignmentConfiguration tags: @@ -61808,7 +83878,7 @@ paths: example: 2c91808781a71ddb0181b9090b53504a configType: $ref: '#/paths/~1reassignment-configurations~1%7BidentityId%7D~1%7BconfigType%7D/delete/parameters/1/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/work-reassignment/ConfigTypeEnum.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/work-reassignment/ConfigTypeEnum.yaml startDate: type: string description: The date from which to start reassigning work items @@ -61831,28 +83901,28 @@ paths: properties: identity: $ref: '#/paths/~1reassignment-configurations/get/responses/200/content/application~1json/schema/items/properties/identity' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/work-reassignment/Identity.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/work-reassignment/Identity.yaml configDetails: type: array description: Details of how work should be reassigned for an Identity items: $ref: '#/paths/~1reassignment-configurations/get/responses/200/content/application~1json/schema/items/properties/configDetails/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/work-reassignment/ConfigurationDetailsResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/work-reassignment/ConfigurationDetailsResponse.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -61864,7 +83934,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#create-reassignment-configuration + label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#create-reassignment-configuration source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $ConfigurationItemRequest = @" @@ -61881,14 +83951,45 @@ paths: try { $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest - New-V2024ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result + New-V2025ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result # Below is a request that includes all optional parameters - # New-V2024ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result + # New-V2025ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ReassignmentConfiguration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ReassignmentConfiguration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-reassignment#create-reassignment-configuration + source: | + from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.configuration_item_request import ConfigurationItemRequest + from sailpoint.v2025.models.configuration_item_response import ConfigurationItemResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + configuration_item_request = '''{ + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + }''' # ConfigurationItemRequest | + try: + # Create a Reassignment Configuration + new_configuration_item_request = ConfigurationItemRequest.from_json(configuration_item_request) + results = WorkReassignmentApi(api_client).create_reassignment_configuration(x_sail_point_experimental=x_sail_point_experimental, configuration_item_request=new_configuration_item_request) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).create_reassignment_configuration(x_sail_point_experimental, new_configuration_item_request) + print("The response of WorkReassignmentApi->create_reassignment_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkReassignmentApi->create_reassignment_configuration: %s\n" % e) /reassignment-configurations/{identityId}: get: operationId: getReassignmentConfiguration @@ -61923,28 +84024,28 @@ paths: application/json: schema: $ref: '#/paths/~1reassignment-configurations/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/work-reassignment/ConfigurationResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/work-reassignment/ConfigurationResponse.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#get-reassignment-configuration + label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#get-reassignment-configuration source: | $IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -61952,14 +84053,38 @@ paths: # Get Reassignment Configuration try { - Get-V2024ReassignmentConfiguration -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + Get-V2025ReassignmentConfiguration -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024ReassignmentConfiguration -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + # Get-V2025ReassignmentConfiguration -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfiguration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ReassignmentConfiguration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-reassignment#get-reassignment-configuration + source: | + from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.configuration_response import ConfigurationResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + identity_id = '2c91808781a71ddb0181b9090b5c504f' # str | unique identity id # str | unique identity id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get Reassignment Configuration + + results = WorkReassignmentApi(api_client).get_reassignment_configuration(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).get_reassignment_configuration(identity_id, x_sail_point_experimental) + print("The response of WorkReassignmentApi->get_reassignment_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_reassignment_configuration: %s\n" % e) put: operationId: putReassignmentConfig tags: @@ -61992,7 +84117,7 @@ paths: application/json: schema: $ref: '#/paths/~1reassignment-configurations/post/requestBody/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/work-reassignment/ConfigurationItemRequest.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/work-reassignment/ConfigurationItemRequest.yaml responses: '200': description: Reassignment Configuration updated @@ -62000,25 +84125,25 @@ paths: application/json: schema: $ref: '#/paths/~1reassignment-configurations/post/responses/201/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/work-reassignment/ConfigurationItemResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/work-reassignment/ConfigurationItemResponse.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#put-reassignment-config + label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#put-reassignment-config source: | $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -62036,14 +84161,46 @@ paths: try { $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest - Send-V2024ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result + Send-V2025ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result # Below is a request that includes all optional parameters - # Send-V2024ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result + # Send-V2025ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ReassignmentConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ReassignmentConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-reassignment#put-reassignment-config + source: | + from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.configuration_item_request import ConfigurationItemRequest + from sailpoint.v2025.models.configuration_item_response import ConfigurationItemResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + configuration_item_request = '''{ + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + }''' # ConfigurationItemRequest | + try: + # Update Reassignment Configuration + new_configuration_item_request = ConfigurationItemRequest.from_json(configuration_item_request) + results = WorkReassignmentApi(api_client).put_reassignment_config(identity_id=identity_id, x_sail_point_experimental=x_sail_point_experimental, configuration_item_request=new_configuration_item_request) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).put_reassignment_config(identity_id, x_sail_point_experimental, new_configuration_item_request) + print("The response of WorkReassignmentApi->put_reassignment_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkReassignmentApi->put_reassignment_config: %s\n" % e) /reassignment-configurations/{identityId}/{configType}: delete: operationId: deleteReassignmentConfiguration @@ -62087,22 +84244,22 @@ paths: description: Reassignment Configuration deleted '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#delete-reassignment-configuration + label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#delete-reassignment-configuration source: | $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | @@ -62111,14 +84268,37 @@ paths: # Delete Reassignment Configuration try { - Remove-V2024ReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental + Remove-V2025ReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Remove-V2024ReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental + # Remove-V2025ReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ReassignmentConfiguration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ReassignmentConfiguration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-reassignment#delete-reassignment-configuration + source: | + from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.config_type_enum import ConfigTypeEnum + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id + config_type = sailpoint.v2025.ConfigTypeEnum() # ConfigTypeEnum | # ConfigTypeEnum | + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Delete Reassignment Configuration + + WorkReassignmentApi(api_client).delete_reassignment_configuration(identity_id=identity_id, config_type=config_type, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # WorkReassignmentApi(api_client).delete_reassignment_configuration(identity_id, config_type, x_sail_point_experimental) + except Exception as e: + print("Exception when calling WorkReassignmentApi->delete_reassignment_configuration: %s\n" % e) /reassignment-configurations/{identityId}/evaluate/{configType}: get: operationId: getEvaluateReassignmentConfiguration @@ -62143,7 +84323,7 @@ paths: required: true schema: $ref: '#/paths/~1reassignment-configurations~1%7BidentityId%7D~1%7BconfigType%7D/delete/parameters/1/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/work-reassignment/ConfigTypeEnum.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/work-reassignment/ConfigTypeEnum.yaml description: Reassignment work type example: accessRequests - in: query @@ -62244,22 +84424,22 @@ paths: reassignmentType: AUTOMATIC_REASSIGNMENT '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#get-evaluate-reassignment-configuration + label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#get-evaluate-reassignment-configuration source: | $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | Reassignment work type @@ -62271,14 +84451,41 @@ paths: # Evaluate Reassignment Configuration try { - Get-V2024EvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental + Get-V2025EvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024EvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental -ExclusionFilters $ExclusionFilters + # Get-V2025EvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental -ExclusionFilters $ExclusionFilters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EvaluateReassignmentConfiguration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EvaluateReassignmentConfiguration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-reassignment#get-evaluate-reassignment-configuration + source: | + from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.config_type_enum import ConfigTypeEnum + from sailpoint.v2025.models.evaluate_response import EvaluateResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id + config_type = sailpoint.v2025.ConfigTypeEnum() # ConfigTypeEnum | Reassignment work type # ConfigTypeEnum | Reassignment work type + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + exclusion_filters = '''['SELF_REVIEW_DELEGATION']''' # List[str] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) + try: + # Evaluate Reassignment Configuration + + results = WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id=identity_id, config_type=config_type, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id, config_type, x_sail_point_experimental, exclusion_filters) + print("The response of WorkReassignmentApi->get_evaluate_reassignment_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_evaluate_reassignment_configuration: %s\n" % e) /reassignment-configurations/tenant-config: get: operationId: getTenantConfigConfiguration @@ -62309,7 +84516,7 @@ paths: example: '2022-07-21T11:13:12.345Z' createdBy: $ref: '#/paths/~1reassignment-configurations/get/responses/200/content/application~1json/schema/items/properties/identity' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/work-reassignment/Identity.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/work-reassignment/Identity.yaml modified: type: string description: Last modified date and time for the record @@ -62317,7 +84524,7 @@ paths: example: '2022-07-21T11:13:12.345Z' modifiedBy: $ref: '#/paths/~1reassignment-configurations/get/responses/200/content/application~1json/schema/items/properties/identity' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/work-reassignment/Identity.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/work-reassignment/Identity.yaml configDetails: type: object description: Details of any tenant-wide Reassignment Configurations (eg. enabled/disabled) @@ -62330,22 +84537,22 @@ paths: example: true '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -62357,21 +84564,44 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#get-tenant-config-configuration + label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#get-tenant-config-configuration source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Get Tenant-wide Reassignment Configuration settings try { - Get-V2024TenantConfigConfiguration -XSailPointExperimental $XSailPointExperimental + Get-V2025TenantConfigConfiguration -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024TenantConfigConfiguration -XSailPointExperimental $XSailPointExperimental + # Get-V2025TenantConfigConfiguration -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TenantConfigConfiguration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TenantConfigConfiguration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-reassignment#get-tenant-config-configuration + source: | + from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.tenant_configuration_response import TenantConfigurationResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get Tenant-wide Reassignment Configuration settings + + results = WorkReassignmentApi(api_client).get_tenant_config_configuration(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).get_tenant_config_configuration(x_sail_point_experimental) + print("The response of WorkReassignmentApi->get_tenant_config_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkReassignmentApi->get_tenant_config_configuration: %s\n" % e) put: operationId: putTenantConfiguration tags: @@ -62391,7 +84621,7 @@ paths: properties: configDetails: $ref: '#/paths/~1reassignment-configurations~1tenant-config/get/responses/200/content/application~1json/schema/properties/configDetails' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/work-reassignment/TenantConfigurationDetails.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/work-reassignment/TenantConfigurationDetails.yaml responses: '200': description: Tenant-wide Reassignment Configuration settings @@ -62399,22 +84629,22 @@ paths: application/json: schema: $ref: '#/paths/~1reassignment-configurations~1tenant-config/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/work-reassignment/TenantConfigurationResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/work-reassignment/TenantConfigurationResponse.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -62426,7 +84656,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#put-tenant-configuration + label: SDK_tools/sdk/powershell/v2025/methods/work-reassignment#put-tenant-configuration source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $TenantConfigurationRequest = @" @@ -62441,18 +84671,47 @@ paths: try { $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest - Send-V2024TenantConfiguration -XSailPointExperimental $XSailPointExperimental -TenantConfigurationRequest $Result + Send-V2025TenantConfiguration -XSailPointExperimental $XSailPointExperimental -TenantConfigurationRequest $Result # Below is a request that includes all optional parameters - # Send-V2024TenantConfiguration -XSailPointExperimental $XSailPointExperimental -TenantConfigurationRequest $Result + # Send-V2025TenantConfiguration -XSailPointExperimental $XSailPointExperimental -TenantConfigurationRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TenantConfiguration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025TenantConfiguration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/work-reassignment#put-tenant-configuration + source: | + from sailpoint.v2025.api.work_reassignment_api import WorkReassignmentApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.tenant_configuration_request import TenantConfigurationRequest + from sailpoint.v2025.models.tenant_configuration_response import TenantConfigurationResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + tenant_configuration_request = '''{ + "configDetails" : { + "disabled" : true + } + }''' # TenantConfigurationRequest | + try: + # Update Tenant-wide Reassignment Configuration settings + new_tenant_configuration_request = TenantConfigurationRequest.from_json(tenant_configuration_request) + results = WorkReassignmentApi(api_client).put_tenant_configuration(x_sail_point_experimental=x_sail_point_experimental, tenant_configuration_request=new_tenant_configuration_request) + # Below is a request that includes all optional parameters + # results = WorkReassignmentApi(api_client).put_tenant_configuration(x_sail_point_experimental, new_tenant_configuration_request) + print("The response of WorkReassignmentApi->put_tenant_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkReassignmentApi->put_tenant_configuration: %s\n" % e) /recommendations/request: post: operationId: getRecommendations - summary: Returns a Recommendation Based on Object + summary: Returns Recommendation Based on Object tags: - IAI Recommendations description: The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations. @@ -62522,7 +84781,7 @@ paths: properties: request: $ref: '#/paths/~1recommendations~1request/post/requestBody/content/application~1json/schema/properties/requests/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/RecommendationRequest.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RecommendationRequest.yaml recommendation: type: string example: 'YES' @@ -62550,7 +84809,7 @@ paths: - department items: $ref: '#/paths/~1ai-access-request-recommendations/get/responses/200/content/application~1json/schema/items/properties/translationMessages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/TranslationMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TranslationMessage.yaml description: The list of translation messages, if they have been requested. recommenderCalculations: properties: @@ -62604,21 +84863,24 @@ paths: description: The number of identities with the corresponding feature '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - - userAuth: [] + - userAuth: + - iai:decisions:manage + x-sailpoint-userLevels: + - Any parameters: - name: X-SailPoint-Experimental in: header @@ -62630,7 +84892,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-recommendations#get-recommendations + label: SDK_tools/sdk/powershell/v2025/methods/iai-recommendations#get-recommendations source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $RecommendationRequestDto = @" @@ -62655,18 +84917,61 @@ paths: } "@ - # Returns a Recommendation Based on Object + # Returns Recommendation Based on Object try { $Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto - Get-V2024Recommendations -XSailPointExperimental $XSailPointExperimental -RecommendationRequestDto $Result + Get-V2025Recommendations -XSailPointExperimental $XSailPointExperimental -RecommendationRequestDto $Result # Below is a request that includes all optional parameters - # Get-V2024Recommendations -XSailPointExperimental $XSailPointExperimental -RecommendationRequestDto $Result + # Get-V2025Recommendations -XSailPointExperimental $XSailPointExperimental -RecommendationRequestDto $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Recommendations" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Recommendations" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-recommendations#get-recommendations + source: | + from sailpoint.v2025.api.iai_recommendations_api import IAIRecommendationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.recommendation_request_dto import RecommendationRequestDto + from sailpoint.v2025.models.recommendation_response_dto import RecommendationResponseDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + recommendation_request_dto = '''{ + "prescribeMode" : false, + "excludeInterpretations" : false, + "requests" : [ { + "item" : { + "id" : "2c938083633d259901633d2623ec0375", + "type" : "ENTITLEMENT" + }, + "identityId" : "2c938083633d259901633d25c68c00fa" + }, { + "item" : { + "id" : "2c938083633d259901633d2623ec0375", + "type" : "ENTITLEMENT" + }, + "identityId" : "2c938083633d259901633d25c68c00fa" + } ], + "includeTranslationMessages" : false, + "includeDebugInformation" : true + }''' # RecommendationRequestDto | + try: + # Returns Recommendation Based on Object + new_recommendation_request_dto = RecommendationRequestDto.from_json(recommendation_request_dto) + results = IAIRecommendationsApi(api_client).get_recommendations(x_sail_point_experimental=x_sail_point_experimental, recommendation_request_dto=new_recommendation_request_dto) + # Below is a request that includes all optional parameters + # results = IAIRecommendationsApi(api_client).get_recommendations(x_sail_point_experimental, new_recommendation_request_dto) + print("The response of IAIRecommendationsApi->get_recommendations:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIRecommendationsApi->get_recommendations: %s\n" % e) /recommendations/config: get: operationId: getRecommendationsConfig @@ -62712,18 +85017,24 @@ paths: example: false '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml + '429': + $ref: '#/paths/~1access-profiles/get/responses/429' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - - userAuth: [] + - userAuth: + - iai:configuration:read + x-sailpoint-userLevels: + - ORG_ADMIN parameters: - name: X-SailPoint-Experimental in: header @@ -62735,21 +85046,44 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-recommendations#get-recommendations-config + label: SDK_tools/sdk/powershell/v2025/methods/iai-recommendations#get-recommendations-config source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Get certification recommendation config values try { - Get-V2024RecommendationsConfig -XSailPointExperimental $XSailPointExperimental + Get-V2025RecommendationsConfig -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024RecommendationsConfig -XSailPointExperimental $XSailPointExperimental + # Get-V2025RecommendationsConfig -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RecommendationsConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RecommendationsConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-recommendations#get-recommendations-config + source: | + from sailpoint.v2025.api.iai_recommendations_api import IAIRecommendationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.recommendation_config_dto import RecommendationConfigDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get certification recommendation config values + + results = IAIRecommendationsApi(api_client).get_recommendations_config(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIRecommendationsApi(api_client).get_recommendations_config(x_sail_point_experimental) + print("The response of IAIRecommendationsApi->get_recommendations_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIRecommendationsApi->get_recommendations_config: %s\n" % e) put: operationId: updateRecommendationsConfig summary: Update certification recommendation config values @@ -62762,7 +85096,7 @@ paths: application/json: schema: $ref: '#/paths/~1recommendations~1config/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/RecommendationConfigDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RecommendationConfigDto.yaml responses: '200': description: Cert recommendation configuration attributes after update @@ -62770,21 +85104,27 @@ paths: application/json: schema: $ref: '#/paths/~1recommendations~1config/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/RecommendationConfigDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RecommendationConfigDto.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml + '429': + $ref: '#/paths/~1access-profiles/get/responses/429' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - - userAuth: [] + - userAuth: + - iai:configuration:manage + x-sailpoint-userLevels: + - ORG_ADMIN parameters: - name: X-SailPoint-Experimental in: header @@ -62796,7 +85136,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-recommendations#update-recommendations-config + label: SDK_tools/sdk/powershell/v2025/methods/iai-recommendations#update-recommendations-config source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $RecommendationConfigDto = @" @@ -62812,14 +85152,43 @@ paths: try { $Result = ConvertFrom-JsonToRecommendationConfigDto -Json $RecommendationConfigDto - Update-V2024RecommendationsConfig -XSailPointExperimental $XSailPointExperimental -RecommendationConfigDto $Result + Update-V2025RecommendationsConfig -XSailPointExperimental $XSailPointExperimental -RecommendationConfigDto $Result # Below is a request that includes all optional parameters - # Update-V2024RecommendationsConfig -XSailPointExperimental $XSailPointExperimental -RecommendationConfigDto $Result + # Update-V2025RecommendationsConfig -XSailPointExperimental $XSailPointExperimental -RecommendationConfigDto $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RecommendationsConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025RecommendationsConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-recommendations#update-recommendations-config + source: | + from sailpoint.v2025.api.iai_recommendations_api import IAIRecommendationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.recommendation_config_dto import RecommendationConfigDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + recommendation_config_dto = '''{ + "recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ], + "peerGroupPercentageThreshold" : 0.5, + "runAutoSelectOnce" : false, + "onlyTuneThreshold" : false + }''' # RecommendationConfigDto | + try: + # Update certification recommendation config values + new_recommendation_config_dto = RecommendationConfigDto.from_json(recommendation_config_dto) + results = IAIRecommendationsApi(api_client).update_recommendations_config(x_sail_point_experimental=x_sail_point_experimental, recommendation_config_dto=new_recommendation_config_dto) + # Below is a request that includes all optional parameters + # results = IAIRecommendationsApi(api_client).update_recommendations_config(x_sail_point_experimental, new_recommendation_config_dto) + print("The response of IAIRecommendationsApi->update_recommendations_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIRecommendationsApi->update_recommendations_config: %s\n" % e) /role-insights/requests: post: operationId: createRoleInsightRequests @@ -62879,19 +85248,19 @@ paths: status: CREATED '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -62903,21 +85272,44 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/role-insights#create-role-insight-requests + label: SDK_tools/sdk/powershell/v2025/methods/role-insights#create-role-insight-requests source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Generate insights for roles try { - New-V2024RoleInsightRequests -XSailPointExperimental $XSailPointExperimental + New-V2025RoleInsightRequests -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # New-V2024RoleInsightRequests -XSailPointExperimental $XSailPointExperimental + # New-V2025RoleInsightRequests -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024RoleInsightRequests" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025RoleInsightRequests" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/role-insights#create-role-insight-requests + source: | + from sailpoint.v2025.api.role_insights_api import RoleInsightsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.role_insights_response import RoleInsightsResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Generate insights for roles + + results = RoleInsightsApi(api_client).create_role_insight_requests(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).create_role_insight_requests(x_sail_point_experimental) + print("The response of RoleInsightsApi->create_role_insight_requests:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RoleInsightsApi->create_role_insight_requests: %s\n" % e) /role-insights/requests/{id}: get: operationId: getRoleInsightsRequests @@ -62950,25 +85342,25 @@ paths: application/json: schema: $ref: '#/paths/~1role-insights~1requests/post/responses/201/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/RoleInsightsResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleInsightsResponse.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/role-insights#get-role-insights-requests + label: SDK_tools/sdk/powershell/v2025/methods/role-insights#get-role-insights-requests source: | $Id = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insights request id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -62976,14 +85368,38 @@ paths: # Returns metadata from prior request. try { - Get-V2024RoleInsightsRequests -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2025RoleInsightsRequests -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024RoleInsightsRequests -Id $Id -XSailPointExperimental $XSailPointExperimental + # Get-V2025RoleInsightsRequests -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsRequests" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleInsightsRequests" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/role-insights#get-role-insights-requests + source: | + from sailpoint.v2025.api.role_insights_api import RoleInsightsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.role_insights_response import RoleInsightsResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insights request id # str | The role insights request id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Returns metadata from prior request. + + results = RoleInsightsApi(api_client).get_role_insights_requests(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).get_role_insights_requests(id, x_sail_point_experimental) + print("The response of RoleInsightsApi->get_role_insights_requests:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights_requests: %s\n" % e) /role-insights/summary: get: operationId: getRoleInsightsSummary @@ -63025,16 +85441,16 @@ paths: example: 980 '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -63046,21 +85462,44 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/role-insights#get-role-insights-summary + label: SDK_tools/sdk/powershell/v2025/methods/role-insights#get-role-insights-summary source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Get role insights summary information try { - Get-V2024RoleInsightsSummary -XSailPointExperimental $XSailPointExperimental + Get-V2025RoleInsightsSummary -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024RoleInsightsSummary -XSailPointExperimental $XSailPointExperimental + # Get-V2025RoleInsightsSummary -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsSummary" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleInsightsSummary" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/role-insights#get-role-insights-summary + source: | + from sailpoint.v2025.api.role_insights_api import RoleInsightsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.role_insights_summary import RoleInsightsSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get role insights summary information + + results = RoleInsightsApi(api_client).get_role_insights_summary(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).get_role_insights_summary(x_sail_point_experimental) + print("The response of RoleInsightsApi->get_role_insights_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights_summary: %s\n" % e) /role-insights: get: operationId: getRoleInsights @@ -63070,11 +85509,11 @@ paths: description: This method returns detailed role insights for each role. parameters: - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - name: sorters in: query description: |- @@ -63188,19 +85627,19 @@ paths: nullable: true '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/role-insights#get-role-insights + label: SDK_tools/sdk/powershell/v2025/methods/role-insights#get-role-insights source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $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) @@ -63212,14 +85651,42 @@ paths: # Get role insights try { - Get-V2024RoleInsights -XSailPointExperimental $XSailPointExperimental + Get-V2025RoleInsights -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024RoleInsights -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters + # Get-V2025RoleInsights -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsights" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleInsights" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/role-insights#get-role-insights + source: | + from sailpoint.v2025.api.role_insights_api import RoleInsightsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.role_insight import RoleInsight + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + 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) + 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) + sorters = 'numberOfUpdates' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) + filters = 'name sw \"John\"' # 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: **name**: *sw* **ownerName**: *sw* **description**: *sw* (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: **name**: *sw* **ownerName**: *sw* **description**: *sw* (optional) + try: + # Get role insights + + results = RoleInsightsApi(api_client).get_role_insights(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).get_role_insights(x_sail_point_experimental, offset, limit, count, sorters, filters) + print("The response of RoleInsightsApi->get_role_insights:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights: %s\n" % e) /role-insights/{insightId}: get: operationId: getRoleInsight @@ -63251,22 +85718,22 @@ paths: application/json: schema: $ref: '#/paths/~1role-insights/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/RoleInsight.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleInsight.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/role-insights#get-role-insight + label: SDK_tools/sdk/powershell/v2025/methods/role-insights#get-role-insight source: | $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -63274,14 +85741,38 @@ paths: # Get a single role insight try { - Get-V2024RoleInsight -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental + Get-V2025RoleInsight -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024RoleInsight -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental + # Get-V2025RoleInsight -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsight" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleInsight" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/role-insights#get-role-insight + source: | + from sailpoint.v2025.api.role_insights_api import RoleInsightsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.role_insight import RoleInsight + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get a single role insight + + results = RoleInsightsApi(api_client).get_role_insight(insight_id=insight_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).get_role_insight(insight_id, x_sail_point_experimental) + print("The response of RoleInsightsApi->get_role_insight:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insight: %s\n" % e) /role-insights/{insightId}/entitlement-changes: get: operationId: getRoleInsightsEntitlementsChanges @@ -63346,39 +85837,46 @@ paths: name: type: string description: Name of the entitlement + example: Administrator id: type: string description: Id of the entitlement + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb description: type: string + nullable: true description: Description for the entitlement + example: Full administrative access to IdentityNow attribute: type: string description: Attribute for the entitlement + example: assignedGroups value: type: string description: Attribute value for the entitlement + example: ORG_ADMIN source: type: string description: Source or the application for the entitlement + example: IdentityNow insight: $ref: '#/paths/~1role-insights/get/responses/200/content/application~1json/schema/items/properties/insight' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/RoleInsightsInsight.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleInsightsInsight.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/role-insights#get-role-insights-entitlements-changes + label: SDK_tools/sdk/powershell/v2025/methods/role-insights#get-role-insights-entitlements-changes source: | $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -63388,14 +85886,40 @@ paths: # Get entitlement insights for a role try { - Get-V2024RoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental + Get-V2025RoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024RoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters + # Get-V2025RoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsEntitlementsChanges" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleInsightsEntitlementsChanges" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/role-insights#get-role-insights-entitlements-changes + source: | + from sailpoint.v2025.api.role_insights_api import RoleInsightsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.role_insights_entitlement_changes import RoleInsightsEntitlementChanges + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sorters = 'sorters_example' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess, name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess, name** (optional) + filters = 'name sw \"Admin\"' # 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: **name**: *sw* **description**: *sw* (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: **name**: *sw* **description**: *sw* (optional) + try: + # Get entitlement insights for a role + + results = RoleInsightsApi(api_client).get_role_insights_entitlements_changes(insight_id=insight_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).get_role_insights_entitlements_changes(insight_id, x_sail_point_experimental, sorters, filters) + print("The response of RoleInsightsApi->get_role_insights_entitlements_changes:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights_entitlements_changes: %s\n" % e) /role-insights/{insightId}/entitlement-changes/download: get: operationId: downloadRoleInsightsEntitlementsChanges @@ -63459,19 +85983,19 @@ paths: type: string '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/role-insights#download-role-insights-entitlements-changes + label: SDK_tools/sdk/powershell/v2025/methods/role-insights#download-role-insights-entitlements-changes source: | $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -63481,14 +86005,39 @@ paths: # Download entitlement insights for a role try { - Invoke-V2024DownloadRoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental + Invoke-V2025DownloadRoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Invoke-V2024DownloadRoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters + # Invoke-V2025DownloadRoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024DownloadRoleInsightsEntitlementsChanges" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025DownloadRoleInsightsEntitlementsChanges" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/role-insights#download-role-insights-entitlements-changes + source: | + from sailpoint.v2025.api.role_insights_api import RoleInsightsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sorters = 'identitiesWithAccess' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional) + filters = 'name sw \"r\"' # 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: **name**: *sw* **description**: *sw* (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: **name**: *sw* **description**: *sw* (optional) + try: + # Download entitlement insights for a role + + results = RoleInsightsApi(api_client).download_role_insights_entitlements_changes(insight_id=insight_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).download_role_insights_entitlements_changes(insight_id, x_sail_point_experimental, sorters, filters) + print("The response of RoleInsightsApi->download_role_insights_entitlements_changes:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RoleInsightsApi->download_role_insights_entitlements_changes: %s\n" % e) /role-insights/{insightId}/current-entitlements: get: operationId: getRoleInsightsCurrentEntitlements @@ -63542,43 +86091,43 @@ paths: name: type: string description: Name of the entitlement + example: Administrator id: type: string description: Id of the entitlement + example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb description: type: string description: Description for the entitlement + nullable: true + example: Full administrative access to IdentityNow source: type: string description: Source or the application for the entitlement + example: IdentityNow attribute: type: string description: Attribute for the entitlement + example: assignedGroups value: type: string description: Attribute value for the entitlement - example: - name: Administrator - id: 8c190e67-87aa-4ed9-a90b-d9d5344523fb - description: Full administrative access to IdentityNow - source: IdentityNow - attribute: assignedGroups - value: ORG_ADMIN + example: ORG_ADMIN '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/role-insights#get-role-insights-current-entitlements + label: SDK_tools/sdk/powershell/v2025/methods/role-insights#get-role-insights-current-entitlements source: | $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -63587,14 +86136,39 @@ paths: # Get current entitlement for a role try { - Get-V2024RoleInsightsCurrentEntitlements -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental + Get-V2025RoleInsightsCurrentEntitlements -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024RoleInsightsCurrentEntitlements -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Filters $Filters + # Get-V2025RoleInsightsCurrentEntitlements -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsCurrentEntitlements" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleInsightsCurrentEntitlements" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/role-insights#get-role-insights-current-entitlements + source: | + from sailpoint.v2025.api.role_insights_api import RoleInsightsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.role_insights_entitlement import RoleInsightsEntitlement + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + filters = 'name sw \"r\"' # 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: **name**: *sw* **description**: *sw* (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: **name**: *sw* **description**: *sw* (optional) + try: + # Get current entitlement for a role + + results = RoleInsightsApi(api_client).get_role_insights_current_entitlements(insight_id=insight_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).get_role_insights_current_entitlements(insight_id, x_sail_point_experimental, filters) + print("The response of RoleInsightsApi->get_role_insights_current_entitlements:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_role_insights_current_entitlements: %s\n" % e) /role-insights/{insightId}/entitlement-changes/{entitlementId}/identities: get: operationId: getEntitlementChangesIdentities @@ -63629,11 +86203,11 @@ paths: type: boolean default: false - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - in: query name: sorters description: |- @@ -63698,19 +86272,19 @@ paths: location: Mexico '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/role-insights#get-entitlement-changes-identities + label: SDK_tools/sdk/powershell/v2025/methods/role-insights#get-entitlement-changes-identities source: | $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id $EntitlementId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The entitlement id @@ -63725,14 +86299,45 @@ paths: # Get identities for a suggested entitlement (for a role) try { - Get-V2024EntitlementChangesIdentities -InsightId $InsightId -EntitlementId $EntitlementId -XSailPointExperimental $XSailPointExperimental + Get-V2025EntitlementChangesIdentities -InsightId $InsightId -EntitlementId $EntitlementId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024EntitlementChangesIdentities -InsightId $InsightId -EntitlementId $EntitlementId -XSailPointExperimental $XSailPointExperimental -HasEntitlement $HasEntitlement -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters + # Get-V2025EntitlementChangesIdentities -InsightId $InsightId -EntitlementId $EntitlementId -XSailPointExperimental $XSailPointExperimental -HasEntitlement $HasEntitlement -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementChangesIdentities" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementChangesIdentities" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/role-insights#get-entitlement-changes-identities + source: | + from sailpoint.v2025.api.role_insights_api import RoleInsightsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.role_insights_identities import RoleInsightsIdentities + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id + entitlement_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The entitlement id # str | The entitlement id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + has_entitlement = False # bool | Identity has this entitlement or not (optional) (default to False) # bool | Identity has this entitlement or not (optional) (default to False) + 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) + 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) + 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) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + filters = 'name sw \"Jan\"' # 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: **name**: *sw* (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: **name**: *sw* (optional) + try: + # Get identities for a suggested entitlement (for a role) + + results = RoleInsightsApi(api_client).get_entitlement_changes_identities(insight_id=insight_id, entitlement_id=entitlement_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = RoleInsightsApi(api_client).get_entitlement_changes_identities(insight_id, entitlement_id, x_sail_point_experimental, has_entitlement, offset, limit, count, sorters, filters) + print("The response of RoleInsightsApi->get_entitlement_changes_identities:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RoleInsightsApi->get_entitlement_changes_identities: %s\n" % e) /role-mining-sessions: post: operationId: createRoleMiningSessions @@ -63847,7 +86452,7 @@ paths: properties: scope: $ref: '#/paths/~1role-mining-sessions/post/requestBody/content/application~1json/schema/properties/scope' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/RoleMiningSessionScope.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleMiningSessionScope.yaml minNumIdentitiesInPotentialRole: type: integer nullable: true @@ -63879,7 +86484,7 @@ paths: status: $ref: '#/paths/~1role-mining-sessions~1%7BsessionId%7D~1status/get/responses/200/content/application~1json/schema' description: The role mining session status - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/RoleMiningSessionStatus.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleMiningSessionStatus.yaml emailRecipientId: type: string description: The id of the user who will receive an email about the role mining session @@ -63933,7 +86538,7 @@ paths: description: The date-time when this role mining session was completed. type: $ref: '#/paths/~1role-mining-sessions/post/requestBody/content/application~1json/schema/properties/type' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/iai/RoleMiningRoleType.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/iai/RoleMiningRoleType.yaml example: scope: identityIds: [] @@ -63959,19 +86564,19 @@ paths: modifiedDate: '2021-09-08T16:11:05.348Z' '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -63983,7 +86588,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#create-role-mining-sessions + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#create-role-mining-sessions source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $RoleMiningSessionDto = @" @@ -64025,14 +86630,70 @@ paths: try { $Result = ConvertFrom-JsonToRoleMiningSessionDto -Json $RoleMiningSessionDto - New-V2024RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -RoleMiningSessionDto $Result + New-V2025RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -RoleMiningSessionDto $Result # Below is a request that includes all optional parameters - # New-V2024RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -RoleMiningSessionDto $Result + # New-V2025RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -RoleMiningSessionDto $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024RoleMiningSessions" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025RoleMiningSessions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#create-role-mining-sessions + source: | + from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.role_mining_session_dto import RoleMiningSessionDto + from sailpoint.v2025.models.role_mining_session_response import RoleMiningSessionResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + role_mining_session_dto = '''{ + "emailRecipientId" : "2c918090761a5aac0176215c46a62d58", + "prescribedPruneThreshold" : 10, + "pruneThreshold" : 50, + "saved" : true, + "potentialRolesReadyCount" : 0, + "scope" : { + "identityIds" : [ "2c918090761a5aac0176215c46a62d58", "2c918090761a5aac01722015c46a62d42" ], + "attributeFilterCriteria" : { + "displayName" : { + "untranslated" : "Location: Miami" + }, + "ariaLabel" : { + "untranslated" : "Location: Miami" + }, + "data" : { + "displayName" : { + "translateKey" : "IDN.IDENTITY_ATTRIBUTES.LOCATION" + }, + "name" : "location", + "operator" : "EQUALS", + "values" : [ "Miami" ] + } + }, + "criteria" : "source.name:DataScienceDataset" + }, + "potentialRoleCount" : 0, + "name" : "Saved RM Session - 07/10", + "minNumIdentitiesInPotentialRole" : 20, + "identityCount" : 0, + "type" : "SPECIALIZED" + }''' # RoleMiningSessionDto | Role mining session parameters + try: + # Create a role mining session + new_role_mining_session_dto = RoleMiningSessionDto.from_json(role_mining_session_dto) + results = IAIRoleMiningApi(api_client).create_role_mining_sessions(x_sail_point_experimental=x_sail_point_experimental, role_mining_session_dto=new_role_mining_session_dto) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).create_role_mining_sessions(x_sail_point_experimental, new_role_mining_session_dto) + print("The response of IAIRoleMiningApi->create_role_mining_sessions:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->create_role_mining_sessions: %s\n" % e) get: operationId: getRoleMiningSessions summary: Retrieves all role mining sessions @@ -64064,11 +86725,11 @@ paths: Sorting is supported for the following fields: **createdBy, createdDate** example: createdBy,createdDate - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - name: X-SailPoint-Experimental in: header description: Use this header to enable this experimental API. @@ -64086,25 +86747,25 @@ paths: type: array items: $ref: '#/paths/~1role-mining-sessions/post/requestBody/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/RoleMiningSessionDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleMiningSessionDto.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-role-mining-sessions + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-role-mining-sessions source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Filters = "saved eq "true" and name sw "RM Session"" # 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: **saved**: *eq* **name**: *eq, sw* (optional) @@ -64116,14 +86777,42 @@ paths: # Retrieves all role mining sessions try { - Get-V2024RoleMiningSessions -XSailPointExperimental $XSailPointExperimental + Get-V2025RoleMiningSessions -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count + # Get-V2025RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningSessions" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleMiningSessions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-role-mining-sessions + source: | + from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.role_mining_session_dto import RoleMiningSessionDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + filters = 'saved eq \"true\" and name sw \"RM Session\"' # 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: **saved**: *eq* **name**: *eq, sw* (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: **saved**: *eq* **name**: *eq, sw* (optional) + sorters = 'createdBy,createdDate' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdBy, createdDate** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdBy, createdDate** (optional) + 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) + 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) + 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: + # Retrieves all role mining sessions + + results = IAIRoleMiningApi(api_client).get_role_mining_sessions(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_role_mining_sessions(x_sail_point_experimental, filters, sorters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_role_mining_sessions:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_role_mining_sessions: %s\n" % e) /role-mining-sessions/{sessionId}: patch: operationId: patchRoleMiningSession @@ -64157,7 +86846,7 @@ paths: type: array items: $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/JsonPatchOperation.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml example: - op: replace path: /pruneThreshold @@ -64177,28 +86866,28 @@ paths: responses: '202': $ref: '#/paths/~1access-requests~1cancel/post/responses/202' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/202.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/202.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#patch-role-mining-session + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#patch-role-mining-session source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be patched $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -64213,14 +86902,39 @@ paths: try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + Update-V2025RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + # Update-V2025RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RoleMiningSession" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025RoleMiningSession" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#patch-role-mining-session + source: | + from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id to be patched # str | The role mining session id to be patched + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch_operation = '''[{op=replace, path=/pruneThreshold, value=83}, {op=replace, path=/minNumIdentitiesInPotentialRole, value=10}, {op=replace, path=/saved, value=false}, {op=replace, path=/name, value=RM Session - 07/10/22}, {op=add, path=/name, value=RM Session - 07/10/22}]''' # List[JsonPatchOperation] | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. + try: + # Patch a role mining session + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = IAIRoleMiningApi(api_client).patch_role_mining_session(session_id=session_id, x_sail_point_experimental=x_sail_point_experimental, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).patch_role_mining_session(session_id, x_sail_point_experimental, new_json_patch_operation) + print("The response of IAIRoleMiningApi->patch_role_mining_session:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->patch_role_mining_session: %s\n" % e) get: operationId: getRoleMiningSession summary: Get a role mining session @@ -64251,28 +86965,28 @@ paths: application/json: schema: $ref: '#/paths/~1role-mining-sessions/post/responses/201/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/RoleMiningSessionResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleMiningSessionResponse.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-role-mining-session + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-role-mining-session source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be retrieved. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -64280,14 +86994,38 @@ paths: # Get a role mining session try { - Get-V2024RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental + Get-V2025RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental + # Get-V2025RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningSession" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleMiningSession" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-role-mining-session + source: | + from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.role_mining_session_response import RoleMiningSessionResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id to be retrieved. # str | The role mining session id to be retrieved. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get a role mining session + + results = IAIRoleMiningApi(api_client).get_role_mining_session(session_id=session_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_role_mining_session(session_id, x_sail_point_experimental) + print("The response of IAIRoleMiningApi->get_role_mining_session:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_role_mining_session: %s\n" % e) /role-mining-sessions/{sessionId}/status: get: operationId: getRoleMiningSessionStatus @@ -64333,19 +87071,19 @@ paths: example: CREATED '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-role-mining-session-status + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-role-mining-session-status source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -64353,14 +87091,38 @@ paths: # Get role mining session status state try { - Get-V2024RoleMiningSessionStatus -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental + Get-V2025RoleMiningSessionStatus -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024RoleMiningSessionStatus -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental + # Get-V2025RoleMiningSessionStatus -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningSessionStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleMiningSessionStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-role-mining-session-status + source: | + from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.role_mining_session_status import RoleMiningSessionStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get role mining session status state + + results = IAIRoleMiningApi(api_client).get_role_mining_session_status(session_id=session_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_role_mining_session_status(session_id, x_sail_point_experimental) + print("The response of IAIRoleMiningApi->get_role_mining_session_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_role_mining_session_status: %s\n" % e) /role-mining-sessions/{sessionId}/potential-role-summaries: get: operationId: getPotentialRoleSummaries @@ -64423,11 +87185,11 @@ paths: schema: type: string - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - name: X-SailPoint-Experimental in: header description: Use this header to enable this experimental API. @@ -64487,6 +87249,7 @@ paths: - PENDING - COMPLETE - FAILED + - null example: POTENTIAL roleId: type: string @@ -64510,13 +87273,13 @@ paths: example: 80 type: $ref: '#/paths/~1role-mining-sessions/post/requestBody/content/application~1json/schema/properties/type' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/iai/RoleMiningRoleType.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/iai/RoleMiningRoleType.yaml createdBy: oneOf: - $ref: '#/paths/~1role-mining-sessions/post/responses/201/content/application~1json/schema/properties/createdBy/oneOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/iai/EntityCreatedByDTO.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/iai/EntityCreatedByDTO.yaml - $ref: '#/paths/~1role-mining-sessions/post/responses/201/content/application~1json/schema/properties/createdBy/oneOf/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/iai/NullableEntityCreatedByDTO.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/iai/NullableEntityCreatedByDTO.yaml description: The potential role created by details createdDate: type: string @@ -64578,15 +87341,15 @@ paths: operator: EQUALS values: - Miami - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/RoleMiningSessionScope.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleMiningSessionScope.yaml type: $ref: '#/paths/~1role-mining-sessions/post/requestBody/content/application~1json/schema/properties/type' description: Role mining potential type - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/iai/RoleMiningRoleType.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/iai/RoleMiningRoleType.yaml state: $ref: '#/paths/~1role-mining-sessions~1%7BsessionId%7D~1status/get/responses/200/content/application~1json/schema/properties/state' description: Role mining session state - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/RoleMiningSessionState.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleMiningSessionState.yaml scopingMethod: type: string description: The scoping method used in the current role mining session. @@ -64596,22 +87359,22 @@ paths: example: MANUAL '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-potential-role-summaries + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-potential-role-summaries source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -64624,14 +87387,43 @@ paths: # Retrieves all potential role summaries try { - Get-V2024PotentialRoleSummaries -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental + Get-V2025PotentialRoleSummaries -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024PotentialRoleSummaries -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count + # Get-V2025PotentialRoleSummaries -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleSummaries" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PotentialRoleSummaries" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-potential-role-summaries + source: | + from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.role_mining_potential_role_summary import RoleMiningPotentialRoleSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sorters = 'createdDate' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate** (optional) + filters = '(createdByName co \"int\")and (createdById sw \"2c9180907\")and (type eq \"COMMON\")and ((name co \"entt\")or (saved eq true))' # 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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* (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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* (optional) + 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) + 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) + 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: + # Retrieves all potential role summaries + + results = IAIRoleMiningApi(api_client).get_potential_role_summaries(session_id=session_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_potential_role_summaries(session_id, x_sail_point_experimental, sorters, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_potential_role_summaries:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role_summaries: %s\n" % e) /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}: get: operationId: getPotentialRole @@ -64675,9 +87467,9 @@ paths: createdBy: oneOf: - $ref: '#/paths/~1role-mining-sessions/post/responses/201/content/application~1json/schema/properties/createdBy/oneOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/iai/EntityCreatedByDTO.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/iai/EntityCreatedByDTO.yaml - $ref: '#/paths/~1role-mining-sessions/post/responses/201/content/application~1json/schema/properties/createdBy/oneOf/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/iai/NullableEntityCreatedByDTO.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/iai/NullableEntityCreatedByDTO.yaml description: The session created by details density: type: integer @@ -64728,8 +87520,7 @@ paths: type: array items: type: object - additionalProperties: - type: string + additionalProperties: true example: - attributeValue: NM Tier 3 count: 6 @@ -64746,8 +87537,11 @@ paths: description: Name of the potential role. example: Saved Potential Role - 07/10 provisionState: - $ref: '#/paths/~1role-mining-sessions~1%7BsessionId%7D~1potential-role-summaries/get/responses/200/content/application~1json/schema/items/properties/provisionState' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/RoleMiningPotentialRoleProvisionState.yaml + allOf: + - $ref: '#/paths/~1role-mining-sessions~1%7BsessionId%7D~1potential-role-summaries/get/responses/200/content/application~1json/schema/items/properties/provisionState' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleMiningPotentialRoleProvisionState.yaml + - description: The provisioning state of a potential role. + nullable: true quality: type: integer description: The quality of a potential role. @@ -64764,10 +87558,10 @@ paths: example: true session: $ref: '#/paths/~1role-mining-sessions~1%7BsessionId%7D~1potential-role-summaries/get/responses/200/content/application~1json/schema/items/properties/session' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/RoleMiningSessionParametersDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleMiningSessionParametersDto.yaml type: $ref: '#/paths/~1role-mining-sessions/post/requestBody/content/application~1json/schema/properties/type' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/iai/RoleMiningRoleType.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/iai/RoleMiningRoleType.yaml id: type: string description: Id of the potential role @@ -64782,22 +87576,22 @@ paths: description: The date-time when this potential role was modified. '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-potential-role + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-potential-role source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session @@ -64806,14 +87600,39 @@ paths: # Retrieves a specific potential role try { - Get-V2024PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + Get-V2025PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + # Get-V2025PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRole" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PotentialRole" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-potential-role + source: | + from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.role_mining_potential_role import RoleMiningPotentialRole + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id + potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Retrieves a specific potential role + + results = IAIRoleMiningApi(api_client).get_potential_role(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_potential_role(session_id, potential_role_id, x_sail_point_experimental) + print("The response of IAIRoleMiningApi->get_potential_role:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role: %s\n" % e) patch: operationId: patchPotentialRole summary: Update a potential role @@ -64866,7 +87685,7 @@ paths: items: allOf: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/JsonPatchOperation.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml properties: op: type: string @@ -64900,28 +87719,28 @@ paths: type: object items: $ref: '#/paths/~1role-mining-sessions~1%7BsessionId%7D~1potential-role-summaries~1%7BpotentialRoleId%7D/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/RoleMiningPotentialRole.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleMiningPotentialRole.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#patch-potential-role + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#patch-potential-role source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id @@ -64933,14 +87752,40 @@ paths: try { $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner - Update-V2024PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result + Update-V2025PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result # Below is a request that includes all optional parameters - # Update-V2024PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result + # Update-V2025PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PotentialRole" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025PotentialRole" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#patch-potential-role + source: | + from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.patch_potential_role_request_inner import PatchPotentialRoleRequestInner + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id + potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The potential role summary id # str | The potential role summary id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + patch_potential_role_request_inner = '''[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]''' # List[PatchPotentialRoleRequestInner] | + try: + # Update a potential role + new_patch_potential_role_request_inner = PatchPotentialRoleRequestInner.from_json(patch_potential_role_request_inner) + results = IAIRoleMiningApi(api_client).patch_potential_role(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental, patch_potential_role_request_inner=new_patch_potential_role_request_inner) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).patch_potential_role(session_id, potential_role_id, x_sail_point_experimental, new_patch_potential_role_request_inner) + print("The response of IAIRoleMiningApi->patch_potential_role:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->patch_potential_role: %s\n" % e) /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications: get: operationId: getPotentialRoleApplications @@ -64978,11 +87823,11 @@ paths: description: A potential role id in a role mining session example: 62f28d91-7d9f-4d17-be15-666d5b41d77f - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - name: X-SailPoint-Experimental in: header description: Use this header to enable this experimental API. @@ -65013,19 +87858,19 @@ paths: name: Slack '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - iai:access-modeling:read @@ -65033,7 +87878,7 @@ paths: - ORG_ADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-potential-role-applications + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-potential-role-applications source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id $PotentialRoleId = "62f28d91-7d9f-4d17-be15-666d5b41d77f" # String | A potential role id in a role mining session @@ -65046,14 +87891,43 @@ paths: # Retrieves the applications of a potential role for a role mining session try { - Get-V2024PotentialRoleApplications -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + Get-V2025PotentialRoleApplications -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024PotentialRoleApplications -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count + # Get-V2025PotentialRoleApplications -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleApplications" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PotentialRoleApplications" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-potential-role-applications + source: | + from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.role_mining_potential_role_application import RoleMiningPotentialRoleApplication + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id + potential_role_id = '62f28d91-7d9f-4d17-be15-666d5b41d77f' # str | A potential role id in a role mining session # str | A potential role id in a role mining session + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + filters = 'applicationName sw \"test\"' # 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: **applicationName**: *sw* (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: **applicationName**: *sw* (optional) + 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) + 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) + 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: + # Retrieves the applications of a potential role for a role mining session + + results = IAIRoleMiningApi(api_client).get_potential_role_applications(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_potential_role_applications(session_id, potential_role_id, x_sail_point_experimental, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_potential_role_applications:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role_applications: %s\n" % e) /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements: get: operationId: getPotentialRoleEntitlements @@ -65091,11 +87965,11 @@ paths: description: A potential role id in a role mining session example: 62f28d91-7d9f-4d17-be15-666d5b41d77f - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - name: X-SailPoint-Experimental in: header description: Use this header to enable this experimental API. @@ -65126,19 +88000,19 @@ paths: name: LauncherTest2 '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - iai:access-modeling:read @@ -65146,7 +88020,7 @@ paths: - ORG_ADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-potential-role-entitlements + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-potential-role-entitlements source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id $PotentialRoleId = "62f28d91-7d9f-4d17-be15-666d5b41d77f" # String | A potential role id in a role mining session @@ -65159,14 +88033,43 @@ paths: # Retrieves the entitlements of a potential role for a role mining session try { - Get-V2024PotentialRoleEntitlements -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + Get-V2025PotentialRoleEntitlements -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024PotentialRoleEntitlements -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count + # Get-V2025PotentialRoleEntitlements -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleEntitlements" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PotentialRoleEntitlements" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-potential-role-entitlements + source: | + from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.role_mining_potential_role_entitlements import RoleMiningPotentialRoleEntitlements + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id + potential_role_id = '62f28d91-7d9f-4d17-be15-666d5b41d77f' # str | A potential role id in a role mining session # str | A potential role id in a role mining session + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + filters = 'entitlementRef.name sw \"test\"' # 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: **entitlementRef.name**: *sw* (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: **entitlementRef.name**: *sw* (optional) + 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) + 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) + 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: + # Retrieves the entitlements of a potential role for a role mining session + + results = IAIRoleMiningApi(api_client).get_potential_role_entitlements(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_potential_role_entitlements(session_id, potential_role_id, x_sail_point_experimental, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_potential_role_entitlements:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role_entitlements: %s\n" % e) /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities: get: operationId: getEntitlementsPotentialRole @@ -65232,11 +88135,11 @@ paths: schema: type: string - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - name: X-SailPoint-Experimental in: header description: Use this header to enable this experimental API. @@ -65315,24 +88218,24 @@ paths: example: 65.6 '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: [] x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-entitlements-potential-role + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-entitlements-potential-role source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session @@ -65347,14 +88250,45 @@ paths: # Retrieves entitlements for a potential role in a role mining session try { - Get-V2024EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + Get-V2025EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -IncludeCommonAccess $IncludeCommonAccess -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count + # Get-V2025EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -IncludeCommonAccess $IncludeCommonAccess -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementsPotentialRole" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementsPotentialRole" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-entitlements-potential-role + source: | + from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.role_mining_entitlement import RoleMiningEntitlement + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id + potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + include_common_access = True # bool | Boolean determining whether common access entitlements will be included or not (optional) (default to True) # bool | Boolean determining whether common access entitlements will be included or not (optional) (default to True) + sorters = 'popularity' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (optional) + filters = 'applicationName sw \"AD\"' # 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: **applicationName**: *sw* **entitlementRef.name**: *sw* (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: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) + 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) + 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) + 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: + # Retrieves entitlements for a potential role in a role mining session + + results = IAIRoleMiningApi(api_client).get_entitlements_potential_role(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, include_common_access, sorters, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_entitlements_potential_role:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_entitlements_potential_role: %s\n" % e) /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution: get: operationId: getEntitlementDistributionPotentialRole @@ -65406,19 +88340,19 @@ paths: type: integer '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-entitlement-distribution-potential-role + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-entitlement-distribution-potential-role source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session @@ -65428,14 +88362,39 @@ paths: # Retrieves entitlement popularity distribution for a potential role in a role mining session try { - Get-V2024EntitlementDistributionPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + Get-V2025EntitlementDistributionPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024EntitlementDistributionPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -IncludeCommonAccess $IncludeCommonAccess + # Get-V2025EntitlementDistributionPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -IncludeCommonAccess $IncludeCommonAccess } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementDistributionPotentialRole" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementDistributionPotentialRole" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-entitlement-distribution-potential-role + source: | + from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id + potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + include_common_access = True # bool | Boolean determining whether common access entitlements will be included or not (optional) # bool | Boolean determining whether common access entitlements will be included or not (optional) + try: + # Retrieves entitlement popularity distribution for a potential role in a role mining session + + results = IAIRoleMiningApi(api_client).get_entitlement_distribution_potential_role(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_entitlement_distribution_potential_role(session_id, potential_role_id, x_sail_point_experimental, include_common_access) + print("The response of IAIRoleMiningApi->get_entitlement_distribution_potential_role:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_entitlement_distribution_potential_role: %s\n" % e) /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements: post: operationId: updateEntitlementsPotentialRole @@ -65496,22 +88455,22 @@ paths: application/json: schema: $ref: '#/paths/~1role-mining-sessions~1%7BsessionId%7D~1potential-role-summaries~1%7BpotentialRoleId%7D/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/RoleMiningPotentialRole.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleMiningPotentialRole.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#update-entitlements-potential-role + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#update-entitlements-potential-role source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session @@ -65527,14 +88486,44 @@ paths: try { $Result = ConvertFrom-JsonToRoleMiningPotentialRoleEditEntitlements -Json $RoleMiningPotentialRoleEditEntitlements - Update-V2024EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -RoleMiningPotentialRoleEditEntitlements $Result + Update-V2025EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -RoleMiningPotentialRoleEditEntitlements $Result # Below is a request that includes all optional parameters - # Update-V2024EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -RoleMiningPotentialRoleEditEntitlements $Result + # Update-V2025EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -RoleMiningPotentialRoleEditEntitlements $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024EntitlementsPotentialRole" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025EntitlementsPotentialRole" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#update-entitlements-potential-role + source: | + from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.role_mining_potential_role import RoleMiningPotentialRole + from sailpoint.v2025.models.role_mining_potential_role_edit_entitlements import RoleMiningPotentialRoleEditEntitlements + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id + potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + role_mining_potential_role_edit_entitlements = '''{ + "ids" : [ "entId1", "entId2" ], + "exclude" : true + }''' # RoleMiningPotentialRoleEditEntitlements | Role mining session parameters + try: + # Edit entitlements for a potential role to exclude some entitlements + new_role_mining_potential_role_edit_entitlements = RoleMiningPotentialRoleEditEntitlements.from_json(role_mining_potential_role_edit_entitlements) + results = IAIRoleMiningApi(api_client).update_entitlements_potential_role(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental, role_mining_potential_role_edit_entitlements=new_role_mining_potential_role_edit_entitlements) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).update_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, new_role_mining_potential_role_edit_entitlements) + print("The response of IAIRoleMiningApi->update_entitlements_potential_role:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->update_entitlements_potential_role: %s\n" % e) /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities: get: operationId: getIdentitiesPotentialRole @@ -65585,11 +88574,11 @@ paths: schema: type: string - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - name: X-SailPoint-Experimental in: header description: Use this header to enable this experimental API. @@ -65611,36 +88600,36 @@ paths: id: type: string description: Id of the identity + example: 2c9180877212632a017228d5934525e6 name: type: string description: Name of the identity + example: Allene Abernathy-Welch attributes: type: object additionalProperties: type: string - example: - id: 2c9180877212632a017228d5934525e6 - name: Allene Abernathy-Welch - attributes: - jobTitle: SQL Developer - department: IT - location: NYC - firstName: Allene + nullable: true + example: + jobTitle: SQL Developer + department: IT + location: NYC + firstName: Allene '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-identities-potential-role + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-identities-potential-role source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session @@ -65654,14 +88643,44 @@ paths: # Retrieves identities for a potential role in a role mining session try { - Get-V2024IdentitiesPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + Get-V2025IdentitiesPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024IdentitiesPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count + # Get-V2025IdentitiesPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitiesPotentialRole" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitiesPotentialRole" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-identities-potential-role + source: | + from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.role_mining_identity import RoleMiningIdentity + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id + potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + filters = 'filters_example' # 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: **name**: *sw* (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: **name**: *sw* (optional) + 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) + 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) + 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: + # Retrieves identities for a potential role in a role mining session + + results = IAIRoleMiningApi(api_client).get_identities_potential_role(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_identities_potential_role(session_id, potential_role_id, x_sail_point_experimental, sorters, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_identities_potential_role:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_identities_potential_role: %s\n" % e) /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export: get: operationId: exportRoleMiningPotentialRole @@ -65704,19 +88723,19 @@ paths: format: binary '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#export-role-mining-potential-role + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#export-role-mining-potential-role source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session @@ -65725,14 +88744,38 @@ paths: # Export (download) details for a potential role in a role mining session try { - Export-V2024RoleMiningPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + Export-V2025RoleMiningPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Export-V2024RoleMiningPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + # Export-V2025RoleMiningPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024RoleMiningPotentialRole" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025RoleMiningPotentialRole" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#export-role-mining-potential-role + source: | + from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id + potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Export (download) details for a potential role in a role mining session + + results = IAIRoleMiningApi(api_client).export_role_mining_potential_role(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).export_role_mining_potential_role(session_id, potential_role_id, x_sail_point_experimental) + print("The response of IAIRoleMiningApi->export_role_mining_potential_role:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role: %s\n" % e) /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async: post: operationId: exportRoleMiningPotentialRoleAsync @@ -65790,7 +88833,7 @@ paths: schema: allOf: - $ref: '#/paths/~1role-mining-sessions~1%7BsessionId%7D~1potential-roles~1%7BpotentialRoleId%7D~1export-async/post/requestBody/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/RoleMiningPotentialRoleExportRequest.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleMiningPotentialRoleExportRequest.yaml - type: object properties: exportId: @@ -65812,19 +88855,19 @@ paths: includeCommonAccess: true '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#export-role-mining-potential-role-async + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#export-role-mining-potential-role-async source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session @@ -65839,14 +88882,44 @@ paths: # Asynchronously export details for a potential role in a role mining session and upload to S3 try { - Export-V2024RoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + Export-V2025RoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Export-V2024RoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -RoleMiningPotentialRoleExportRequest $Result + # Export-V2025RoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -RoleMiningPotentialRoleExportRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024RoleMiningPotentialRoleAsync" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025RoleMiningPotentialRoleAsync" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#export-role-mining-potential-role-async + source: | + from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.role_mining_potential_role_export_request import RoleMiningPotentialRoleExportRequest + from sailpoint.v2025.models.role_mining_potential_role_export_response import RoleMiningPotentialRoleExportResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id + potential_role_id = '278359a6-04b7-4669-9468-924cf580964a' # str | A potential role id in a role mining session # str | A potential role id in a role mining session + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + role_mining_potential_role_export_request = '''{ + "minEntitlementPopularity" : 0, + "includeCommonAccess" : true + }''' # RoleMiningPotentialRoleExportRequest | (optional) + try: + # Asynchronously export details for a potential role in a role mining session and upload to S3 + + results = IAIRoleMiningApi(api_client).export_role_mining_potential_role_async(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).export_role_mining_potential_role_async(session_id, potential_role_id, x_sail_point_experimental, new_role_mining_potential_role_export_request) + print("The response of IAIRoleMiningApi->export_role_mining_potential_role_async:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role_async: %s\n" % e) /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}: get: operationId: exportRoleMiningPotentialRoleStatus @@ -65897,22 +88970,22 @@ paths: application/json: schema: $ref: '#/paths/~1role-mining-sessions~1%7BsessionId%7D~1potential-roles~1%7BpotentialRoleId%7D~1export-async/post/responses/202/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/RoleMiningPotentialRoleExportResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleMiningPotentialRoleExportResponse.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#export-role-mining-potential-role-status + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#export-role-mining-potential-role-status source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session @@ -65922,14 +88995,40 @@ paths: # Retrieve status of a potential role export job try { - Export-V2024RoleMiningPotentialRoleStatus -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental + Export-V2025RoleMiningPotentialRoleStatus -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Export-V2024RoleMiningPotentialRoleStatus -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental + # Export-V2025RoleMiningPotentialRoleStatus -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024RoleMiningPotentialRoleStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025RoleMiningPotentialRoleStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#export-role-mining-potential-role-status + source: | + from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.role_mining_potential_role_export_response import RoleMiningPotentialRoleExportResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id + potential_role_id = '278359a6-04b7-4669-9468-924cf580964a' # str | A potential role id in a role mining session # str | A potential role id in a role mining session + export_id = '4940ffd4-836f-48a3-b2b0-6d498c3fdf40' # str | The id of a previously run export job for this potential role # str | The id of a previously run export job for this potential role + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Retrieve status of a potential role export job + + results = IAIRoleMiningApi(api_client).export_role_mining_potential_role_status(session_id=session_id, potential_role_id=potential_role_id, export_id=export_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).export_role_mining_potential_role_status(session_id, potential_role_id, export_id, x_sail_point_experimental) + print("The response of IAIRoleMiningApi->export_role_mining_potential_role_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->export_role_mining_potential_role_status: %s\n" % e) /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download: get: operationId: downloadRoleMiningPotentialRoleZip @@ -65983,19 +89082,19 @@ paths: format: binary '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#download-role-mining-potential-role-zip + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#download-role-mining-potential-role-zip source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session @@ -66005,14 +89104,39 @@ paths: # Export (download) details for a potential role in a role mining session try { - Invoke-V2024DownloadRoleMiningPotentialRoleZip -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental + Invoke-V2025DownloadRoleMiningPotentialRoleZip -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Invoke-V2024DownloadRoleMiningPotentialRoleZip -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental + # Invoke-V2025DownloadRoleMiningPotentialRoleZip -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024DownloadRoleMiningPotentialRoleZip" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025DownloadRoleMiningPotentialRoleZip" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#download-role-mining-potential-role-zip + source: | + from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id + potential_role_id = '278359a6-04b7-4669-9468-924cf580964a' # str | A potential role id in a role mining session # str | A potential role id in a role mining session + export_id = '4940ffd4-836f-48a3-b2b0-6d498c3fdf40' # str | The id of a previously run export job for this potential role # str | The id of a previously run export job for this potential role + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Export (download) details for a potential role in a role mining session + + results = IAIRoleMiningApi(api_client).download_role_mining_potential_role_zip(session_id=session_id, potential_role_id=potential_role_id, export_id=export_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).download_role_mining_potential_role_zip(session_id, potential_role_id, export_id, x_sail_point_experimental) + print("The response of IAIRoleMiningApi->download_role_mining_potential_role_zip:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->download_role_mining_potential_role_zip: %s\n" % e) /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision: post: operationId: createPotentialRoleProvisionRequest @@ -66101,25 +89225,25 @@ paths: application/json: schema: $ref: '#/paths/~1role-mining-sessions~1%7BsessionId%7D~1potential-role-summaries/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/RoleMiningPotentialRoleSummary.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleMiningPotentialRoleSummary.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#create-potential-role-provision-request + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#create-potential-role-provision-request source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session @@ -66139,14 +89263,49 @@ paths: # Create request to provision a potential role into an actual role. try { - New-V2024PotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + New-V2025PotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # New-V2024PotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -MinEntitlementPopularity $MinEntitlementPopularity -IncludeCommonAccess $IncludeCommonAccess -RoleMiningPotentialRoleProvisionRequest $Result + # New-V2025PotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -MinEntitlementPopularity $MinEntitlementPopularity -IncludeCommonAccess $IncludeCommonAccess -RoleMiningPotentialRoleProvisionRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PotentialRoleProvisionRequest" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025PotentialRoleProvisionRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#create-potential-role-provision-request + source: | + from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.role_mining_potential_role_provision_request import RoleMiningPotentialRoleProvisionRequest + from sailpoint.v2025.models.role_mining_potential_role_summary import RoleMiningPotentialRoleSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id + potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + min_entitlement_popularity = 0 # int | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) # int | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) + include_common_access = True # bool | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to True) # bool | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to True) + role_mining_potential_role_provision_request = '''{ + "includeIdentities" : true, + "roleName" : "Finance - Accounting", + "ownerId" : "2b568c65bc3c4c57a43bd97e3a8e41", + "roleDescription" : "General access for accounting department", + "directlyAssignedEntitlements" : false + }''' # RoleMiningPotentialRoleProvisionRequest | Required information to create a new role (optional) + try: + # Create request to provision a potential role into an actual role. + + results = IAIRoleMiningApi(api_client).create_potential_role_provision_request(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).create_potential_role_provision_request(session_id, potential_role_id, x_sail_point_experimental, min_entitlement_popularity, include_common_access, new_role_mining_potential_role_provision_request) + print("The response of IAIRoleMiningApi->create_potential_role_provision_request:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->create_potential_role_provision_request: %s\n" % e) /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements: get: operationId: getExcludedEntitlementsPotentialRole @@ -66200,11 +89359,11 @@ paths: schema: type: string - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - name: X-SailPoint-Experimental in: header description: Use this header to enable this experimental API. @@ -66222,22 +89381,22 @@ paths: type: array items: $ref: '#/paths/~1role-mining-sessions~1%7BsessionId%7D~1potential-roles~1%7BpotentialRoleId%7D~1entitlement-popularities/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/RoleMiningEntitlement.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleMiningEntitlement.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-excluded-entitlements-potential-role + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-excluded-entitlements-potential-role source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session @@ -66251,14 +89410,44 @@ paths: # Retrieves excluded entitlements for a potential role in a role mining session try { - Get-V2024ExcludedEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + Get-V2025ExcludedEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024ExcludedEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count + # Get-V2025ExcludedEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ExcludedEntitlementsPotentialRole" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ExcludedEntitlementsPotentialRole" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-excluded-entitlements-potential-role + source: | + from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.role_mining_entitlement import RoleMiningEntitlement + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id + potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sorters = 'populariity' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity** (optional) + filters = 'applicationName sw \"AD\"' # 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: **applicationName**: *sw* **entitlementRef.name**: *sw* (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: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) + 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) + 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) + 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: + # Retrieves excluded entitlements for a potential role in a role mining session + + results = IAIRoleMiningApi(api_client).get_excluded_entitlements_potential_role(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_excluded_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, sorters, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_excluded_entitlements_potential_role:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_excluded_entitlements_potential_role: %s\n" % e) /role-mining-potential-roles: get: operationId: getAllPotentialRoleSummaries @@ -66321,11 +89510,11 @@ paths: schema: type: string - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - name: X-SailPoint-Experimental in: header description: Use this header to enable this experimental API. @@ -66343,25 +89532,25 @@ paths: type: array items: $ref: '#/paths/~1role-mining-sessions~1%7BsessionId%7D~1potential-role-summaries/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/RoleMiningPotentialRoleSummary.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleMiningPotentialRoleSummary.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-all-potential-role-summaries + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-all-potential-role-summaries source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Sorters = "createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate, identityCount, entitlementCount, freshness, quality** (optional) @@ -66373,14 +89562,42 @@ paths: # Retrieves all potential role summaries try { - Get-V2024AllPotentialRoleSummaries -XSailPointExperimental $XSailPointExperimental + Get-V2025AllPotentialRoleSummaries -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024AllPotentialRoleSummaries -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count + # Get-V2025AllPotentialRoleSummaries -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AllPotentialRoleSummaries" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AllPotentialRoleSummaries" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-all-potential-role-summaries + source: | + from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.role_mining_potential_role_summary import RoleMiningPotentialRoleSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sorters = 'createdDate' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate, identityCount, entitlementCount, freshness, quality** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate, identityCount, entitlementCount, freshness, quality** (optional) + filters = '(createdByName co \"int\") and (createdById sw \"2c9180907\") and (type eq \"COMMON\") and ((name co \"entt\") or (saved eq true))' # 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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (optional) + 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) + 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) + 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: + # Retrieves all potential role summaries + + results = IAIRoleMiningApi(api_client).get_all_potential_role_summaries(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_all_potential_role_summaries(x_sail_point_experimental, sorters, filters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_all_potential_role_summaries:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_all_potential_role_summaries: %s\n" % e) /role-mining-potential-roles/{potentialRoleId}: get: operationId: getRoleMiningPotentialRole @@ -66414,25 +89631,25 @@ paths: application/json: schema: $ref: '#/paths/~1role-mining-sessions~1%7BsessionId%7D~1potential-role-summaries~1%7BpotentialRoleId%7D/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/RoleMiningPotentialRole.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleMiningPotentialRole.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-role-mining-potential-role + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-role-mining-potential-role source: | $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -66440,14 +89657,38 @@ paths: # Retrieves a specific potential role try { - Get-V2024RoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + Get-V2025RoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024RoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental + # Get-V2025RoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningPotentialRole" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleMiningPotentialRole" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-role-mining-potential-role + source: | + from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.role_mining_potential_role import RoleMiningPotentialRole + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id # str | A potential role id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Retrieves a specific potential role + + results = IAIRoleMiningApi(api_client).get_role_mining_potential_role(potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_role_mining_potential_role(potential_role_id, x_sail_point_experimental) + print("The response of IAIRoleMiningApi->get_role_mining_potential_role:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_role_mining_potential_role: %s\n" % e) patch: operationId: patchPotentialRole summary: Update a potential role @@ -66502,7 +89743,7 @@ paths: items: allOf: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/JsonPatchOperation.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml properties: op: type: string @@ -66536,28 +89777,28 @@ paths: type: object items: $ref: '#/paths/~1role-mining-sessions~1%7BsessionId%7D~1potential-role-summaries~1%7BpotentialRoleId%7D/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/RoleMiningPotentialRole.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RoleMiningPotentialRole.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#patch-potential-role-0 + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#patch-potential-role-0 source: | $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id @@ -66569,14 +89810,40 @@ paths: try { $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner - Update-V2024PotentialRole0 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result + Update-V2025PotentialRole0 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result # Below is a request that includes all optional parameters - # Update-V2024PotentialRole0 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result + # Update-V2025PotentialRole0 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PotentialRole0" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025PotentialRole0" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#patch-potential-role-0 + source: | + from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.patch_potential_role_request_inner import PatchPotentialRoleRequestInner + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id + potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The potential role summary id # str | The potential role summary id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + patch_potential_role_request_inner = '''[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]''' # List[PatchPotentialRoleRequestInner] | + try: + # Update a potential role + new_patch_potential_role_request_inner = PatchPotentialRoleRequestInner.from_json(patch_potential_role_request_inner) + results = IAIRoleMiningApi(api_client).patch_potential_role_0(session_id=session_id, potential_role_id=potential_role_id, x_sail_point_experimental=x_sail_point_experimental, patch_potential_role_request_inner=new_patch_potential_role_request_inner) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).patch_potential_role_0(session_id, potential_role_id, x_sail_point_experimental, new_patch_potential_role_request_inner) + print("The response of IAIRoleMiningApi->patch_potential_role_0:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->patch_potential_role_0: %s\n" % e) /role-mining-potential-roles/saved: get: operationId: getSavedPotentialRoles @@ -66598,11 +89865,11 @@ paths: description: 'Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified**' example: modified - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - name: X-SailPoint-Experimental in: header description: Use this header to enable this experimental API. @@ -66660,7 +89927,7 @@ paths: example: '2020-09-16T18:49:32.150Z' type: $ref: '#/paths/~1role-mining-sessions/post/requestBody/content/application~1json/schema/properties/type' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/iai/RoleMiningRoleType.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/iai/RoleMiningRoleType.yaml id: type: string description: Id of the potential draft role @@ -66675,22 +89942,22 @@ paths: description: The date-time when this potential draft role was modified. '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-saved-potential-roles + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-saved-potential-roles source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** (optional) @@ -66701,14 +89968,41 @@ paths: # Retrieves all saved potential roles try { - Get-V2024SavedPotentialRoles -XSailPointExperimental $XSailPointExperimental + Get-V2025SavedPotentialRoles -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024SavedPotentialRoles -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count + # Get-V2025SavedPotentialRoles -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedPotentialRoles" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SavedPotentialRoles" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-saved-potential-roles + source: | + from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.role_mining_session_draft_role_dto import RoleMiningSessionDraftRoleDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sorters = 'modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** (optional) + 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) + 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) + 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: + # Retrieves all saved potential roles + + results = IAIRoleMiningApi(api_client).get_saved_potential_roles(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_saved_potential_roles(x_sail_point_experimental, sorters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_saved_potential_roles:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_saved_potential_roles: %s\n" % e) /role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage: get: operationId: getPotentialRoleSourceIdentityUsage @@ -66746,11 +90040,11 @@ paths: description: 'Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount**' example: '-usageCount' - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - name: X-SailPoint-Experimental in: header description: Use this header to enable this experimental API. @@ -66788,22 +90082,22 @@ paths: example: 25 '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-role-mining#get-potential-role-source-identity-usage + label: SDK_tools/sdk/powershell/v2025/methods/iai-role-mining#get-potential-role-source-identity-usage source: | $PotentialRoleId = "e0cc5d7d-bf7f-4f81-b2af-8885b09d9923" # String | A potential role id $SourceId = "2c9180877620c1460176267f336a106f" # String | A source id @@ -66816,36 +90110,65 @@ paths: # Retrieves potential role source usage try { - Get-V2024PotentialRoleSourceIdentityUsage -PotentialRoleId $PotentialRoleId -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental + Get-V2025PotentialRoleSourceIdentityUsage -PotentialRoleId $PotentialRoleId -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024PotentialRoleSourceIdentityUsage -PotentialRoleId $PotentialRoleId -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count + # Get-V2025PotentialRoleSourceIdentityUsage -PotentialRoleId $PotentialRoleId -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleSourceIdentityUsage" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PotentialRoleSourceIdentityUsage" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/iai-role-mining#get-potential-role-source-identity-usage + source: | + from sailpoint.v2025.api.iai_role_mining_api import IAIRoleMiningApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.role_mining_potential_role_source_usage import RoleMiningPotentialRoleSourceUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + potential_role_id = 'e0cc5d7d-bf7f-4f81-b2af-8885b09d9923' # str | A potential role id # str | A potential role id + source_id = '2c9180877620c1460176267f336a106f' # str | A source id # str | A source id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sorters = '-usageCount' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** (optional) + 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) + 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) + 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: + # Retrieves potential role source usage + + results = IAIRoleMiningApi(api_client).get_potential_role_source_identity_usage(potential_role_id=potential_role_id, source_id=source_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = IAIRoleMiningApi(api_client).get_potential_role_source_identity_usage(potential_role_id, source_id, x_sail_point_experimental, sorters, offset, limit, count) + print("The response of IAIRoleMiningApi->get_potential_role_source_identity_usage:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IAIRoleMiningApi->get_potential_role_source_identity_usage: %s\n" % e) /roles/{id}/entitlements: get: operationId: getRoleEntitlements tags: - Roles - summary: List role's Entitlements - description: This API lists the Entitlements associated with a given role. + summary: List Role's Entitlements + description: Get a list of entitlements associated with a specified role. parameters: - name: id in: path - description: ID of the containing role + description: Containing role's ID. required: true x-sailpoint-resource-operation-id: listRoles schema: type: string example: 2c91808a7813090a017814121919ecca - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1connector-rules/get/parameters/0' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit50.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - in: query name: filters schema: @@ -66900,22 +90223,22 @@ paths: type: array items: $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/Entitlement.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Entitlement.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:role-unchecked:read @@ -66933,27 +90256,56 @@ paths: - ROLE_SUBADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/roles#get-role-entitlements + label: SDK_tools/sdk/powershell/v2025/methods/roles#get-role-entitlements source: | - $Id = "2c91808a7813090a017814121919ecca" # String | ID of the containing role + $Id = "2c91808a7813090a017814121919ecca" # String | Containing role's ID. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $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) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) $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) $Filters = "attribute eq "memberOf"" # 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: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) - # List role's Entitlements + # List Role's Entitlements try { - Get-V2024RoleEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2025RoleEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024RoleEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + # Get-V2025RoleEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleEntitlements" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025RoleEntitlements" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/roles#get-role-entitlements + source: | + from sailpoint.v2025.api.roles_api import RolesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.entitlement import Entitlement + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121919ecca' # str | Containing role's ID. # str | Containing role's ID. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + 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) + filters = 'attribute eq \"memberOf\"' # 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: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (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: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) + sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) + try: + # List Role's Entitlements + + results = RolesApi(api_client).get_role_entitlements(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).get_role_entitlements(id, x_sail_point_experimental, limit, offset, count, filters, sorters) + print("The response of RolesApi->get_role_entitlements:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RolesApi->get_role_entitlements: %s\n" % e) /send-test-notification: post: operationId: sendTestNotification @@ -66991,25 +90343,25 @@ paths: responses: '204': $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/204.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -67021,7 +90373,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/notifications#send-test-notification + label: SDK_tools/sdk/powershell/v2025/methods/notifications#send-test-notification source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $SendTestNotificationRequestDto = @" @@ -67036,14 +90388,40 @@ paths: try { $Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto - Send-V2024TestNotification -XSailPointExperimental $XSailPointExperimental -SendTestNotificationRequestDto $Result + Send-V2025TestNotification -XSailPointExperimental $XSailPointExperimental -SendTestNotificationRequestDto $Result # Below is a request that includes all optional parameters - # Send-V2024TestNotification -XSailPointExperimental $XSailPointExperimental -SendTestNotificationRequestDto $Result + # Send-V2025TestNotification -XSailPointExperimental $XSailPointExperimental -SendTestNotificationRequestDto $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TestNotification" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025TestNotification" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/notifications#send-test-notification + source: | + from sailpoint.v2025.api.notifications_api import NotificationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.send_test_notification_request_dto import SendTestNotificationRequestDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + send_test_notification_request_dto = '''{ + "context" : "{}", + "medium" : "EMAIL", + "key" : "cloud_manual_work_item_summary" + }''' # SendTestNotificationRequestDto | + try: + # Send Test Notification + new_send_test_notification_request_dto = SendTestNotificationRequestDto.from_json(send_test_notification_request_dto) + NotificationsApi(api_client).send_test_notification(x_sail_point_experimental=x_sail_point_experimental, send_test_notification_request_dto=new_send_test_notification_request_dto) + # Below is a request that includes all optional parameters + # NotificationsApi(api_client).send_test_notification(x_sail_point_experimental, new_send_test_notification_request_dto) + except Exception as e: + print("Exception when calling NotificationsApi->send_test_notification: %s\n" % e) /sim-integrations/{id}: put: tags: @@ -67060,7 +90438,7 @@ paths: title: Sim Integration Details allOf: - $ref: '#/components/schemas/Account/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/BaseCommonDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BaseCommonDto.yaml - type: object properties: description: @@ -67114,39 +90492,8 @@ paths: description: Before provisioning rule of integration properties: type: - type: string - enum: - - ACCOUNT_CORRELATION_CONFIG - - ACCESS_PROFILE - - ACCESS_REQUEST_APPROVAL - - ACCOUNT - - APPLICATION - - CAMPAIGN - - CAMPAIGN_FILTER - - CERTIFICATION - - CLUSTER - - CONNECTOR_SCHEMA - - ENTITLEMENT - - GOVERNANCE_GROUP - - IDENTITY - - IDENTITY_PROFILE - - IDENTITY_REQUEST - - MACHINE_IDENTITY - - LIFECYCLE_STATE - - PASSWORD_POLICY - - ROLE - - RULE - - SOD_POLICY - - SOURCE - - TAG - - TAG_CATEGORY - - TASK_RESULT - - REPORT_RESULT - - SOD_VIOLATION - - ACCOUNT_ACTIVITY - - WORKGROUP - description: An enumeration of the types of DTOs supported within the IdentityNow infrastructure. - example: IDENTITY + $ref: '#/components/schemas/Account/allOf/1/properties/ownerIdentity/allOf/0/properties/type' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/DtoType.yaml id: type: string description: ID of the rule @@ -67180,25 +90527,25 @@ paths: application/json: schema: $ref: '#/paths/~1service-desk-integrations/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ServiceDeskIntegrationDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ServiceDeskIntegrationDto.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:service-desk-admin:create @@ -67206,7 +90553,7 @@ paths: - ORG_ADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#put-sim-integration + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#put-sim-integration source: | $Id = "12345" # String | The id of the integration. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -67235,14 +90582,57 @@ paths: try { $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + Send-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result # Below is a request that includes all optional parameters - # Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + # Send-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SIMIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SIMIntegration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#put-sim-integration + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.v2025.models.sim_integration_details import SimIntegrationDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration. # str | The id of the integration. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sim_integration_details = '''{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }''' # SimIntegrationDetails | The full DTO of the integration containing the updated model + try: + # Update an existing SIM integration + new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) + results = SIMIntegrationsApi(api_client).put_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).put_sim_integration(id, x_sail_point_experimental, new_sim_integration_details) + print("The response of SIMIntegrationsApi->put_sim_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->put_sim_integration: %s\n" % e) get: tags: - SIM Integrations @@ -67273,25 +90663,25 @@ paths: application/json: schema: $ref: '#/paths/~1service-desk-integrations/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ServiceDeskIntegrationDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ServiceDeskIntegrationDto.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:service-desk-admin:read @@ -67299,7 +90689,7 @@ paths: - ORG_ADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#get-sim-integration + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#get-sim-integration source: | $Id = "12345" # String | The id of the integration. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -67307,14 +90697,38 @@ paths: # Get a SIM integration details. try { - Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + # Get-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SIMIntegration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#get-sim-integration + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration. # str | The id of the integration. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get a SIM integration details. + + results = SIMIntegrationsApi(api_client).get_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).get_sim_integration(id, x_sail_point_experimental) + print("The response of SIMIntegrationsApi->get_sim_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integration: %s\n" % e) delete: tags: - SIM Integrations @@ -67343,22 +90757,22 @@ paths: description: No content response '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:service-desk-admin:write @@ -67366,7 +90780,7 @@ paths: - ORG_ADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#delete-sim-integration + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#delete-sim-integration source: | $Id = "12345" # String | The id of the integration to delete. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -67374,14 +90788,35 @@ paths: # Delete a SIM integration try { - Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + Remove-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + # Remove-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SIMIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SIMIntegration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#delete-sim-integration + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Delete a SIM integration + + SIMIntegrationsApi(api_client).delete_sim_integration(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # SIMIntegrationsApi(api_client).delete_sim_integration(id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->delete_sim_integration: %s\n" % e) patch: tags: - SIM Integrations @@ -67394,15 +90829,8 @@ paths: content: application/json-patch+json: schema: - type: object - description: A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) - properties: - operations: - description: Operations to be applied - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/JsonPatchOperation.yaml + $ref: '#/paths/~1configuration-hub~1scheduled-actions~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatch.yaml parameters: - name: id description: SIM integration id @@ -67427,25 +90855,25 @@ paths: application/json: schema: $ref: '#/paths/~1service-desk-integrations/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ServiceDeskIntegrationDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ServiceDeskIntegrationDto.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:service-desk-admin:write @@ -67453,7 +90881,7 @@ paths: - ORG_ADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#patch-sim-attributes + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#patch-sim-attributes source: | $Id = "12345" # String | SIM integration id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -67475,14 +90903,50 @@ paths: try { $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + Update-V2025SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result # Below is a request that includes all optional parameters - # Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + # Update-V2025SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SIMAttributes" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SIMAttributes" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#patch-sim-attributes + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch import JsonPatch + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | SIM integration id # str | SIM integration id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JsonPatch object that describes the changes of SIM + try: + # Patch a SIM attribute. + new_json_patch = JsonPatch.from_json(json_patch) + results = SIMIntegrationsApi(api_client).patch_sim_attributes(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).patch_sim_attributes(id, x_sail_point_experimental, new_json_patch) + print("The response of SIMIntegrationsApi->patch_sim_attributes:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_sim_attributes: %s\n" % e) /sim-integrations/{id}/beforeProvisioningRule: patch: tags: @@ -67496,8 +90960,8 @@ paths: content: application/json-patch+json: schema: - $ref: '#/paths/~1sim-integrations~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/JsonPatch.yaml + $ref: '#/paths/~1configuration-hub~1scheduled-actions~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatch.yaml parameters: - name: id in: path @@ -67522,25 +90986,25 @@ paths: application/json: schema: $ref: '#/paths/~1service-desk-integrations/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ServiceDeskIntegrationDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ServiceDeskIntegrationDto.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:service-desk-admin:write @@ -67548,7 +91012,7 @@ paths: - ORG_ADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#patch-before-provisioning-rule + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#patch-before-provisioning-rule source: | $Id = "12345" # String | SIM integration id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -67570,14 +91034,50 @@ paths: try { $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + Update-V2025BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result # Below is a request that includes all optional parameters - # Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + # Update-V2025BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024BeforeProvisioningRule" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025BeforeProvisioningRule" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#patch-before-provisioning-rule + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch import JsonPatch + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '12345' # str | SIM integration id # str | SIM integration id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch = '''{ + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + }''' # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. + try: + # Patch a SIM beforeProvisioningRule attribute. + new_json_patch = JsonPatch.from_json(json_patch) + results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch=new_json_patch) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, x_sail_point_experimental, new_json_patch) + print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->patch_before_provisioning_rule: %s\n" % e) /sim-integrations: get: tags: @@ -67591,26 +91091,28 @@ paths: content: application/json: schema: - $ref: '#/paths/~1service-desk-integrations/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ServiceDeskIntegrationDto.yaml + type: array + items: + $ref: '#/paths/~1service-desk-integrations/get/responses/200/content/application~1json/schema/items' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ServiceDeskIntegrationDto.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:service-desk-admin:read @@ -67627,21 +91129,44 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#get-sim-integrations + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#get-sim-integrations source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # List the existing SIM integrations. try { - Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental + Get-V2025SIMIntegrations -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental + # Get-V2025SIMIntegrations -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegrations" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SIMIntegrations" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#get-sim-integrations + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # List the existing SIM integrations. + + results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) + print("The response of SIMIntegrationsApi->get_sim_integrations:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) post: tags: - SIM Integrations @@ -67654,7 +91179,7 @@ paths: application/json: schema: $ref: '#/paths/~1sim-integrations~1%7Bid%7D/put/requestBody/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/SimIntegrationDetails.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SimIntegrationDetails.yaml required: true responses: '200': @@ -67663,25 +91188,25 @@ paths: application/json: schema: $ref: '#/paths/~1service-desk-integrations/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ServiceDeskIntegrationDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ServiceDeskIntegrationDto.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:service-desk-admin:create @@ -67698,7 +91223,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#create-sim-integration + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#create-sim-integration source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $SimIntegrationDetails = @" @@ -67726,14 +91251,56 @@ paths: try { $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + New-V2025SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result # Below is a request that includes all optional parameters - # New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + # New-V2025SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SIMIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SIMIntegration" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sim-integrations#create-sim-integration + source: | + from sailpoint.v2025.api.sim_integrations_api import SIMIntegrationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.v2025.models.sim_integration_details import SimIntegrationDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + sim_integration_details = '''{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + }''' # SimIntegrationDetails | DTO containing the details of the SIM integration + try: + # Create new SIM integration + new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details) + results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental=x_sail_point_experimental, sim_integration_details=new_sim_integration_details) + # Below is a request that includes all optional parameters + # results = SIMIntegrationsApi(api_client).create_sim_integration(x_sail_point_experimental, new_sim_integration_details) + print("The response of SIMIntegrationsApi->create_sim_integration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SIMIntegrationsApi->create_sim_integration: %s\n" % e) /sp-config/export: post: operationId: exportSpConfig @@ -67828,7 +91395,7 @@ paths: type: object additionalProperties: $ref: '#/paths/~1sp-config~1import/post/requestBody/content/multipart~1form-data/schema/properties/options/properties/objectOptions/additionalProperties' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ObjectExportImportOptions.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ObjectExportImportOptions.yaml example: TRIGGER_SUBSCRIPTION: includedIds: @@ -67928,7 +91495,7 @@ paths: schema: allOf: - $ref: '#/paths/~1sp-config~1import/post/responses/202/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/SpConfigJob.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SpConfigJob.yaml - type: object nullable: true properties: @@ -67943,25 +91510,25 @@ paths: application/json: schema: $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ErrorResponseDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ErrorResponseDto.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#export-sp-config + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#export-sp-config source: | $ExportPayload = @" { @@ -67973,14 +91540,39 @@ paths: try { $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload - Export-V2024SpConfig -ExportPayload $Result + Export-V2025SpConfig -ExportPayload $Result # Below is a request that includes all optional parameters - # Export-V2024SpConfig -ExportPayload $Result + # Export-V2025SpConfig -ExportPayload $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024SpConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025SpConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#export-sp-config + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.export_payload import ExportPayload + from sailpoint.v2025.models.sp_config_export_job import SpConfigExportJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + export_payload = '''{ + "description" : "Export Job 1 Test" + }''' # ExportPayload | Export options control what will be included in the export. + try: + # Initiates configuration objects export job + new_export_payload = ExportPayload.from_json(export_payload) + results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).export_sp_config(new_export_payload) + print("The response of SPConfigApi->export_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->export_sp_config: %s\n" % e) /sp-config/export/{id}: get: operationId: getSpConfigExportStatus @@ -68014,7 +91606,7 @@ paths: schema: allOf: - $ref: '#/paths/~1sp-config~1export/post/responses/202/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/SpConfigExportJob.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SpConfigExportJob.yaml - type: object nullable: true properties: @@ -68035,39 +91627,61 @@ paths: completed: '2021-05-13T15:04:27.358Z' '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-export-status + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-export-status source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. # Get export job status try { - Get-V2024SpConfigExportStatus -Id $Id + Get-V2025SpConfigExportStatus -Id $Id # Below is a request that includes all optional parameters - # Get-V2024SpConfigExportStatus -Id $Id + # Get-V2025SpConfigExportStatus -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExportStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigExportStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-export-status + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sp_config_export_job_status import SpConfigExportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned. + try: + # Get export job status + + results = SPConfigApi(api_client).get_sp_config_export_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export_status(id) + print("The response of SPConfigApi->get_sp_config_export_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export_status: %s\n" % e) /sp-config/export/{id}/download: get: operationId: getSpConfigExport @@ -68269,39 +91883,61 @@ paths: additionalProperties: true '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-export + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-export source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. # Download export job result. try { - Get-V2024SpConfigExport -Id $Id + Get-V2025SpConfigExport -Id $Id # Below is a request that includes all optional parameters - # Get-V2024SpConfigExport -Id $Id + # Get-V2025SpConfigExport -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExport" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigExport" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-export + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sp_config_export_results import SpConfigExportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded. + try: + # Download export job result. + + results = SPConfigApi(api_client).get_sp_config_export(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_export(id) + print("The response of SPConfigApi->get_sp_config_export:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_export: %s\n" % e) /sp-config/import: post: operationId: importSpConfig @@ -68503,25 +92139,25 @@ paths: application/json: schema: $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ErrorResponseDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ErrorResponseDto.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#import-sp-config + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#import-sp-config source: | $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) @@ -68531,14 +92167,39 @@ paths: # Initiates configuration objects import job try { - Import-V2024SpConfig -Data $Data + Import-V2025SpConfig -Data $Data # Below is a request that includes all optional parameters - # Import-V2024SpConfig -Data $Data -Preview $Preview -Options $Options + # Import-V2025SpConfig -Data $Data -Preview $Preview -Options $Options } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024SpConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025SpConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#import-sp-config + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.import_options import ImportOptions + from sailpoint.v2025.models.sp_config_job import SpConfigJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. + preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) + options = '''sailpoint.v2025.ImportOptions()''' # ImportOptions | (optional) + try: + # Initiates configuration objects import job + + results = SPConfigApi(api_client).import_sp_config(data=data) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).import_sp_config(data, preview, options) + print("The response of SPConfigApi->import_sp_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->import_sp_config: %s\n" % e) /sp-config/import/{id}: get: operationId: getSpConfigImportStatus @@ -68572,7 +92233,7 @@ paths: schema: allOf: - $ref: '#/paths/~1sp-config~1import/post/responses/202/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/SpConfigJob.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SpConfigJob.yaml - type: object nullable: true properties: @@ -68600,39 +92261,61 @@ paths: completed: '2021-05-13T16:42:40.705Z' '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-import-status + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-import-status source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. # Get import job status try { - Get-V2024SpConfigImportStatus -Id $Id + Get-V2025SpConfigImportStatus -Id $Id # Below is a request that includes all optional parameters - # Get-V2024SpConfigImportStatus -Id $Id + # Get-V2025SpConfigImportStatus -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImportStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigImportStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-import-status + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sp_config_import_job_status import SpConfigImportJobStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned. + try: + # Get import job status + + results = SPConfigApi(api_client).get_sp_config_import_status(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import_status(id) + print("The response of SPConfigApi->get_sp_config_import_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import_status: %s\n" % e) /sp-config/import/{id}/download: get: operationId: getSpConfigImport @@ -68706,13 +92389,13 @@ paths: type: array items: $ref: '#/paths/~1sp-config~1import~1%7Bid%7D~1download/get/responses/200/content/application~1json/schema/properties/results/additionalProperties/properties/infos/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/beta/schemas/SpConfigMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/beta/schemas/SpConfigMessage.yaml errors: description: Error messages returned from the target service on import. type: array items: $ref: '#/paths/~1sp-config~1import~1%7Bid%7D~1download/get/responses/200/content/application~1json/schema/properties/results/additionalProperties/properties/infos/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/beta/schemas/SpConfigMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/beta/schemas/SpConfigMessage.yaml importedObjects: description: References to objects that were created or updated by the import. type: array @@ -68767,39 +92450,61 @@ paths: - results '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-import + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-import source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. # Download import job result try { - Get-V2024SpConfigImport -Id $Id + Get-V2025SpConfigImport -Id $Id # Below is a request that includes all optional parameters - # Get-V2024SpConfigImport -Id $Id + # Get-V2025SpConfigImport -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImport" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigImport" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#get-sp-config-import + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sp_config_import_results import SpConfigImportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded. + try: + # Download import job result + + results = SPConfigApi(api_client).get_sp_config_import(id=id) + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).get_sp_config_import(id) + print("The response of SPConfigApi->get_sp_config_import:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->get_sp_config_import: %s\n" % e) /sp-config/config-objects: get: operationId: listSpConfigObjects @@ -68903,7 +92608,7 @@ paths: type: array items: $ref: '#/paths/~1sp-config~1config-objects/get/responses/200/content/application~1json/schema/items/properties/rules/properties/takeFromTargetRules/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/SpConfigRule.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SpConfigRule.yaml editable: type: boolean default: false @@ -68911,38 +92616,59 @@ paths: example: true '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#list-sp-config-objects + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#list-sp-config-objects source: | # Get config object details try { - Get-V2024SpConfigObjects + Get-V2025SpConfigObjects # Below is a request that includes all optional parameters - # Get-V2024SpConfigObjects + # Get-V2025SpConfigObjects } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigObjects" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigObjects" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sp-config#list-sp-config-objects + source: | + from sailpoint.v2025.api.sp_config_api import SPConfigApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sp_config_object import SpConfigObject + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get config object details + + results = SPConfigApi(api_client).list_sp_config_objects() + # Below is a request that includes all optional parameters + # results = SPConfigApi(api_client).list_sp_config_objects() + print("The response of SPConfigApi->list_sp_config_objects:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) /sources/{id}/attribute-sync-config: get: operationId: getSourceAttrSyncConfig @@ -69002,6 +92728,7 @@ paths: example: 2c9180835d191a86015d28455b4b232a name: type: string + nullable: true description: Human-readable name of target source for attribute synchronization. example: HR Active Directory attributes: @@ -69043,25 +92770,25 @@ paths: target: givenName '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#get-source-attr-sync-config + label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-attr-sync-config source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -69069,14 +92796,38 @@ paths: # Attribute Sync Config try { - Get-V2024SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2025SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental + # Get-V2025SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceAttrSyncConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceAttrSyncConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#get-source-attr-sync-config + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.attr_sync_source_config import AttrSyncSourceConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Attribute Sync Config + + results = SourcesApi(api_client).get_source_attr_sync_config(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_source_attr_sync_config(id, x_sail_point_experimental) + print("The response of SourcesApi->get_source_attr_sync_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->get_source_attr_sync_config: %s\n" % e) put: operationId: putSourceAttrSyncConfig tags: @@ -69112,7 +92863,7 @@ paths: application/json: schema: $ref: '#/paths/~1sources~1%7Bid%7D~1attribute-sync-config/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/AttrSyncSourceConfig.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AttrSyncSourceConfig.yaml responses: '200': description: Updated attribute synchronization configuration for a source @@ -69120,28 +92871,28 @@ paths: application/json: schema: $ref: '#/paths/~1sources~1%7Bid%7D~1attribute-sync-config/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/AttrSyncSourceConfig.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/AttrSyncSourceConfig.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#put-source-attr-sync-config + label: SDK_tools/sdk/powershell/v2025/methods/sources#put-source-attr-sync-config source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -69170,577 +92921,56 @@ paths: try { $Result = ConvertFrom-JsonToAttrSyncSourceConfig -Json $AttrSyncSourceConfig - Send-V2024SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -AttrSyncSourceConfig $Result + Send-V2025SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -AttrSyncSourceConfig $Result # Below is a request that includes all optional parameters - # Send-V2024SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -AttrSyncSourceConfig $Result + # Send-V2025SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -AttrSyncSourceConfig $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SourceAttrSyncConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SourceAttrSyncConfig" Write-Host $_.ErrorDetails } - /sources/{sourceId}/connector/check-connection: - post: - operationId: testSourceConnection - tags: - - Sources - summary: Check connection for source connector. - description: This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. - security: - - userAuth: - - idn:source-connector:manage - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: sourceId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSources - description: The ID of the Source. - example: cef3ee201db947c5912551015ba0c679 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: The result of checking connection to the source connector with response from it. - content: - application/json: - schema: - type: object - title: Status Response - description: Response model for connection check, configuration test and ping of source connectors. - properties: - id: - type: string - description: ID of the source - example: 2c91808568c529c60168cca6f90c1313 - readOnly: true - name: - type: string - description: Name of the source - example: ODS-AD-Test [source-999999] - readOnly: true - status: - type: string - enum: - - SUCCESS - - FAILURE - description: The status of the health check. - example: SUCCESS - readOnly: true - elapsedMillis: - type: integer - description: The number of milliseconds spent on the entire request. - example: 1000 - readOnly: true - details: - type: object - description: | - The document contains the results of the health check. - The schema of this document depends on the type of source used. - readOnly: true - example: - useTLSForIQService: false - IQService: - TLS Port: 0 - .NET CLR Version: 4.0.30319.42000 - SecondaryServiceStatus: Running - Port: 5050 - Host: AUTOMATION-AD - Name: IQService - IQServiceStatus: Running - SecondaryService: IQService-Instance1-Secondary - Version: IQService Sep-2020 - secondaryPort: 5051 - OS Architecture: AMD64 - Operating System: Microsoft Windows Server 2012 R2 Standard - highestDotNetVersion: 4.8 or later - Build Time: 09/22/2020 06:34 AM -0500 - IQServiceClientAuthEnabled: false - requestProcessedOn: 1/19/2021 1:47:14 PM - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#test-source-connection + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#put-source-attr-sync-config source: | - $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.attr_sync_source_config import AttrSyncSourceConfig + from sailpoint.configuration import Configuration + configuration = Configuration() - # Check connection for source connector. + configuration.experimental = true - try { - Test-V2024SourceConnection -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Test-V2024SourceConnection -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024SourceConnection" - Write-Host $_.ErrorDetails - } - /sources/{sourceId}/connector/peek-resource-objects: - post: - operationId: peekResourceObjects - tags: - - Sources - summary: Peek source connector's resource objects - description: Retrieves a sample of data returned from account and group aggregation requests. - security: - - userAuth: - - idn:source-connector:manage - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: sourceId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSources - description: The ID of the Source - example: cef3ee201db947c5912551015ba0c679 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - requestBody: - required: true - content: - application/json: - schema: - type: object - title: Resource Objects Request - description: Request model for peek resource objects from source connectors. - properties: - objectType: - type: string - description: The type of resource objects to iterate over. - default: account - example: group - maxCount: - type: integer - description: The maximum number of resource objects to iterate over and return. - default: 25 - example: 100 - responses: - '200': - description: List of resource objects that was fetched from the source connector. - content: - application/json: - schema: - type: object - title: Resource Objects Response - description: Response model for peek resource objects from source connectors. - properties: - id: - type: string - description: ID of the source - example: 2c91808568c529c60168cca6f90c1313 - readOnly: true - name: - type: string - description: Name of the source - example: ODS-AD-Test [source-999999] - readOnly: true - objectCount: - type: integer - description: The number of objects that were fetched by the connector. - example: 25 - readOnly: true - elapsedMillis: - type: integer - description: The number of milliseconds spent on the entire request. - example: 1055 - readOnly: true - resourceObjects: - type: array - items: - type: object - title: Resource Object - description: Representation of the object which is returned from source connectors. - properties: - instance: - description: Identifier of the specific instance where this object resides. - type: string - readOnly: true - identity: - description: Native identity of the object in the Source. - type: string - example: CN=Aaron Carr,OU=test1,DC=test2,DC=test - readOnly: true - uuid: - description: Universal unique identifier of the object in the Source. - type: string - example: '{abf7bd9b-68b4-4d21-9b70-870c58ebf844}' - readOnly: true - previousIdentity: - description: Native identity that the object has previously. - type: string - readOnly: true - name: - description: Display name for this object. - type: string - example: Aaron Carr - readOnly: true - objectType: - description: Type of object. - type: string - example: account - readOnly: true - incomplete: - description: A flag indicating that this is an incomplete object. Used in special cases where the connector has to return account information in several phases and the objects might not have a complete set of all account attributes. The attributes in this object will replace the corresponding attributes in the Link, but no other Link attributes will be changed. - type: boolean - example: false - readOnly: true - incremental: - description: A flag indicating that this is an incremental change object. This is similar to incomplete but it also means that the values of any multi-valued attributes in this object should be merged with the existing values in the Link rather than replacing the existing Link value. - type: boolean - example: false - readOnly: true - delete: - description: A flag indicating that this object has been deleted. This is set only when doing delta aggregation and the connector supports detection of native deletes. - type: boolean - example: false - readOnly: true - remove: - description: A flag set indicating that the values in the attributes represent things to remove rather than things to add. Setting this implies incremental. The values which are always for multi-valued attributes are removed from the current values. - type: boolean - example: false - readOnly: true - missing: - description: A list of attribute names that are not included in this object. This is only used with SMConnector and will only contain "groups". - type: array - items: - type: string - example: - - missFieldOne - - missFieldTwo - readOnly: true - attributes: - description: Attributes of this ResourceObject. - type: object - example: - telephoneNumber: 12-(345)678-9012 - mail: example@test.com - displayName: Aaron Carr - readOnly: true - finalUpdate: - description: In Aggregation, for sparse object the count for total accounts scanned identities updated is not incremented. - type: boolean - example: false - readOnly: true - description: Fetched objects from the source connector. - readOnly: true - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#peek-resource-objects - source: | - $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $ResourceObjectsRequest = @" - { - "maxCount" : 100, - "objectType" : "group" - } - "@ - - # Peek source connector's resource objects - - try { - $Result = ConvertFrom-JsonToResourceObjectsRequest -Json $ResourceObjectsRequest - Receive-V2024ResourceObjects -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental -ResourceObjectsRequest $Result - - # Below is a request that includes all optional parameters - # Receive-V2024ResourceObjects -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental -ResourceObjectsRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Receive-V2024ResourceObjects" - Write-Host $_.ErrorDetails - } - /sources/{sourceId}/connector/ping-cluster: - post: - operationId: pingCluster - tags: - - Sources - summary: Ping cluster for source connector - description: This endpoint validates that the cluster being used by the source is reachable from IdentityNow. - security: - - userAuth: - - idn:source-connector:manage - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: sourceId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSources - description: The ID of the Source - example: cef3ee201db947c5912551015ba0c679 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: The result of pinging connection with the source connector. - content: - application/json: - schema: - $ref: '#/paths/~1sources~1%7BsourceId%7D~1connector~1check-connection/post/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/StatusResponse.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#ping-cluster - source: | - $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Ping cluster for source connector - - try { - Ping-V2024Cluster -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Ping-V2024Cluster -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-V2024Cluster" - Write-Host $_.ErrorDetails - } - /sources/{sourceId}/connector/test-configuration: - post: - operationId: testSourceConfiguration - tags: - - Sources - summary: Test configuration for source connector - description: This endpoint performs a more detailed validation of the source''s configuration that can take longer than the lighter weight credential validation performed by the checkConnection API. - security: - - userAuth: - - idn:source-connector:manage - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: sourceId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSources - description: The ID of the Source - example: cef3ee201db947c5912551015ba0c679 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: The result of testing source connector configuration with response from it. - content: - application/json: - schema: - $ref: '#/paths/~1sources~1%7BsourceId%7D~1connector~1check-connection/post/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/StatusResponse.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#test-source-configuration - source: | - $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Test configuration for source connector - - try { - Test-V2024SourceConfiguration -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Test-V2024SourceConfiguration -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024SourceConfiguration" - Write-Host $_.ErrorDetails - } - /sources/{id}/connectors/source-config: - get: - operationId: getSourceConfig - tags: - - Sources - summary: Gets source config with language translations - security: - - userAuth: [] - x-sailpoint-userLevels: - - ORG_ADMIN - description: Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSources - description: The Source id - - in: query - name: locale - schema: - type: string - enum: - - de - - false - - fi - - sv - - ru - - pt - - ko - - zh-TW - - en - - it - - fr - - zh-CN - - hu - - es - - cs - - ja - - pl - - da - - nl - description: The locale to apply to the config. If no viable locale is given, it will default to "en" - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true - responses: - '200': - description: A Connector Detail object - content: - application/json: - schema: - $ref: '#/paths/~1connectors~1%7BscriptName%7D/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ConnectorDetail.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#get-source-config - source: | - $Id = "MyId" # String | The Source id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) - - # Gets source config with language translations - - try { - Get-V2024SourceConfig -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024SourceConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceConfig" - Write-Host $_.ErrorDetails - } + with ApiClient(configuration) as api_client: + id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + attr_sync_source_config = '''{ + "attributes" : [ { + "name" : "email", + "displayName" : "Email", + "enabled" : true, + "target" : "mail" + }, { + "name" : "firstname", + "displayName" : "First Name", + "enabled" : false, + "target" : "givenName" + } ], + "source" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + } + }''' # AttrSyncSourceConfig | + try: + # Update Attribute Sync Config + new_attr_sync_source_config = AttrSyncSourceConfig.from_json(attr_sync_source_config) + results = SourcesApi(api_client).put_source_attr_sync_config(id=id, x_sail_point_experimental=x_sail_point_experimental, attr_sync_source_config=new_attr_sync_source_config) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).put_source_attr_sync_config(id, x_sail_point_experimental, new_attr_sync_source_config) + print("The response of SourcesApi->put_source_attr_sync_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->put_source_attr_sync_config: %s\n" % e) /sources/{sourceId}/native-change-detection-config: get: operationId: getNativeChangeDetectionConfig @@ -69829,25 +93059,25 @@ paths: - servicePrincipalName '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#get-native-change-detection-config + label: SDK_tools/sdk/powershell/v2025/methods/sources#get-native-change-detection-config source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -69855,14 +93085,38 @@ paths: # Native Change Detection Configuration try { - Get-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2025NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental + # Get-V2025NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NativeChangeDetectionConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025NativeChangeDetectionConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#get-native-change-detection-config + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.native_change_detection_config import NativeChangeDetectionConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Native Change Detection Configuration + + results = SourcesApi(api_client).get_native_change_detection_config(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_native_change_detection_config(id, x_sail_point_experimental) + print("The response of SourcesApi->get_native_change_detection_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->get_native_change_detection_config: %s\n" % e) put: operationId: putNativeChangeDetectionConfig tags: @@ -69897,7 +93151,7 @@ paths: application/json: schema: $ref: '#/paths/~1sources~1%7BsourceId%7D~1native-change-detection-config/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/NativeChangeDetectionConfig.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/NativeChangeDetectionConfig.yaml responses: '200': description: Updated native change detection configuration for a source @@ -69905,28 +93159,28 @@ paths: application/json: schema: $ref: '#/paths/~1sources~1%7BsourceId%7D~1native-change-detection-config/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/NativeChangeDetectionConfig.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/NativeChangeDetectionConfig.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#put-native-change-detection-config + label: SDK_tools/sdk/powershell/v2025/methods/sources#put-native-change-detection-config source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -69945,14 +93199,46 @@ paths: try { $Result = ConvertFrom-JsonToNativeChangeDetectionConfig -Json $NativeChangeDetectionConfig - Send-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -NativeChangeDetectionConfig $Result + Send-V2025NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -NativeChangeDetectionConfig $Result # Below is a request that includes all optional parameters - # Send-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -NativeChangeDetectionConfig $Result + # Send-V2025NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -NativeChangeDetectionConfig $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024NativeChangeDetectionConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025NativeChangeDetectionConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#put-native-change-detection-config + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.native_change_detection_config import NativeChangeDetectionConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + native_change_detection_config = '''{ + "selectedEntitlements" : [ "memberOf", "memberOfSharedMailbox" ], + "operations" : [ "ACCOUNT_UPDATED", "ACCOUNT_DELETED" ], + "selectedNonEntitlementAttributes" : [ "lastName", "phoneNumber", "objectType", "servicePrincipalName" ], + "allNonEntitlementAttributes" : false, + "allEntitlements" : false, + "enabled" : true + }''' # NativeChangeDetectionConfig | + try: + # Update Native Change Detection Configuration + new_native_change_detection_config = NativeChangeDetectionConfig.from_json(native_change_detection_config) + results = SourcesApi(api_client).put_native_change_detection_config(id=id, x_sail_point_experimental=x_sail_point_experimental, native_change_detection_config=new_native_change_detection_config) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).put_native_change_detection_config(id, x_sail_point_experimental, new_native_change_detection_config) + print("The response of SourcesApi->put_native_change_detection_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->put_native_change_detection_config: %s\n" % e) delete: operationId: deleteNativeChangeDetectionConfig tags: @@ -69986,28 +93272,28 @@ paths: responses: '204': $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/204.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#delete-native-change-detection-config + label: SDK_tools/sdk/powershell/v2025/methods/sources#delete-native-change-detection-config source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -70015,14 +93301,35 @@ paths: # Delete Native Change Detection Configuration try { - Remove-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental + Remove-V2025NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Remove-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental + # Remove-V2025NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NativeChangeDetectionConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025NativeChangeDetectionConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#delete-native-change-detection-config + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Delete Native Change Detection Configuration + + SourcesApi(api_client).delete_native_change_detection_config(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # SourcesApi(api_client).delete_native_change_detection_config(id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling SourcesApi->delete_native_change_detection_config: %s\n" % e) /sources/{id}/remove-accounts: post: operationId: deleteAccountsAsync @@ -70060,32 +93367,32 @@ paths: application/json: schema: $ref: '#/paths/~1roles~1bulk-delete/post/responses/202/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/TaskResultDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TaskResultDto.yaml example: type: TASK_RESULT id: 464ae7bf791e49fdb74606a2e4a89635 name: null '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - - idn:account:manage + - idn:accounts:manage x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#delete-accounts-async + label: SDK_tools/sdk/powershell/v2025/methods/sources#delete-accounts-async source: | $Id = "ebbf35756e1140699ce52b233121384a" # String | The source id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -70093,14 +93400,38 @@ paths: # Remove All Accounts in a Source try { - Remove-V2024AccountsAsync -Id $Id -XSailPointExperimental $XSailPointExperimental + Remove-V2025AccountsAsync -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Remove-V2024AccountsAsync -Id $Id -XSailPointExperimental $XSailPointExperimental + # Remove-V2025AccountsAsync -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccountsAsync" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025AccountsAsync" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#delete-accounts-async + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.task_result_dto import TaskResultDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = 'ebbf35756e1140699ce52b233121384a' # str | The source id # str | The source id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Remove All Accounts in a Source + + results = SourcesApi(api_client).delete_accounts_async(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).delete_accounts_async(id, x_sail_point_experimental) + print("The response of SourcesApi->delete_accounts_async:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->delete_accounts_async: %s\n" % e) /sources/{id}/synchronize-attributes: post: operationId: syncAttributesForSource @@ -70176,25 +93507,25 @@ paths: dataJson: '{"sourceId":"2c918083746f642c01746f990884012a"}' '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#sync-attributes-for-source + label: SDK_tools/sdk/powershell/v2025/methods/sources#sync-attributes-for-source source: | $Id = "MyId" # String | The Source id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -70202,14 +93533,38 @@ paths: # Synchronize single source attributes. try { - Sync-V2024AttributesForSource -Id $Id -XSailPointExperimental $XSailPointExperimental + Sync-V2025AttributesForSource -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Sync-V2024AttributesForSource -Id $Id -XSailPointExperimental $XSailPointExperimental + # Sync-V2025AttributesForSource -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2024AttributesForSource" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2025AttributesForSource" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#sync-attributes-for-source + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.source_sync_job import SourceSyncJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = 'id_example' # str | The Source id # str | The Source id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Synchronize single source attributes. + + results = SourcesApi(api_client).sync_attributes_for_source(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).sync_attributes_for_source(id, x_sail_point_experimental) + print("The response of SourcesApi->sync_attributes_for_source:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->sync_attributes_for_source: %s\n" % e) /sources/{id}/entitlement-request-config: get: security: @@ -70313,19 +93668,19 @@ paths: denialCommentRequired: false '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -70337,21 +93692,44 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#get-source-entitlement-request-config + label: SDK_tools/sdk/powershell/v2025/methods/sources#get-source-entitlement-request-config source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Get Source Entitlement Request Configuration try { - Get-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental + Get-V2025SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental + # Get-V2025SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceEntitlementRequestConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceEntitlementRequestConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#get-source-entitlement-request-config + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.source_entitlement_request_config import SourceEntitlementRequestConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get Source Entitlement Request Configuration + + results = SourcesApi(api_client).get_source_entitlement_request_config(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).get_source_entitlement_request_config(x_sail_point_experimental) + print("The response of SourcesApi->get_source_entitlement_request_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->get_source_entitlement_request_config: %s\n" % e) put: security: - userAuth: @@ -70376,7 +93754,7 @@ paths: application/json: schema: $ref: '#/paths/~1sources~1%7Bid%7D~1entitlement-request-config/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/SourceEntitlementRequestConfig.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SourceEntitlementRequestConfig.yaml examples: Set config with no approvals: description: If no approvals are required, the following config can be set. @@ -70409,22 +93787,22 @@ paths: application/json: schema: $ref: '#/paths/~1sources~1%7Bid%7D~1entitlement-request-config/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/SourceEntitlementRequestConfig.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SourceEntitlementRequestConfig.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -70436,7 +93814,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#update-source-entitlement-request-config + label: SDK_tools/sdk/powershell/v2025/methods/sources#update-source-entitlement-request-config source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $SourceEntitlementRequestConfig = @" @@ -70459,14 +93837,50 @@ paths: try { $Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig - Update-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -SourceEntitlementRequestConfig $Result + Update-V2025SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -SourceEntitlementRequestConfig $Result # Below is a request that includes all optional parameters - # Update-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -SourceEntitlementRequestConfig $Result + # Update-V2025SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -SourceEntitlementRequestConfig $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceEntitlementRequestConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SourceEntitlementRequestConfig" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#update-source-entitlement-request-config + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.source_entitlement_request_config import SourceEntitlementRequestConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + source_entitlement_request_config = '''{ + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } + }''' # SourceEntitlementRequestConfig | + try: + # Update Source Entitlement Request Configuration + new_source_entitlement_request_config = SourceEntitlementRequestConfig.from_json(source_entitlement_request_config) + results = SourcesApi(api_client).update_source_entitlement_request_config(x_sail_point_experimental=x_sail_point_experimental, source_entitlement_request_config=new_source_entitlement_request_config) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).update_source_entitlement_request_config(x_sail_point_experimental, new_source_entitlement_request_config) + print("The response of SourcesApi->update_source_entitlement_request_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->update_source_entitlement_request_config: %s\n" % e) /sources/{id}/load-accounts: post: tags: @@ -70709,22 +94123,22 @@ paths: attributeName: groupsCreated '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#import-accounts + label: SDK_tools/sdk/powershell/v2025/methods/sources#import-accounts source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -70734,14 +94148,40 @@ paths: # Account Aggregation try { - Import-V2024Accounts -Id $Id -XSailPointExperimental $XSailPointExperimental + Import-V2025Accounts -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Import-V2024Accounts -Id $Id -XSailPointExperimental $XSailPointExperimental -File $File -DisableOptimization $DisableOptimization + # Import-V2025Accounts -Id $Id -XSailPointExperimental $XSailPointExperimental -File $File -DisableOptimization $DisableOptimization } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024Accounts" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025Accounts" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#import-accounts + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.load_accounts_task import LoadAccountsTask + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + file = None # bytearray | The CSV file containing the source accounts to aggregate. (optional) # bytearray | The CSV file containing the source accounts to aggregate. (optional) + disable_optimization = 'disable_optimization_example' # str | Use this flag to reprocess every account whether or not the data has changed. (optional) # str | Use this flag to reprocess every account whether or not the data has changed. (optional) + try: + # Account Aggregation + + results = SourcesApi(api_client).import_accounts(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).import_accounts(id, x_sail_point_experimental, file, disable_optimization) + print("The response of SourcesApi->import_accounts:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->import_accounts: %s\n" % e) /sources/{id}/load-uncorrelated-accounts: post: tags: @@ -70958,22 +94398,22 @@ paths: attributeName: groupsCreated '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#import-uncorrelated-accounts + label: SDK_tools/sdk/powershell/v2025/methods/sources#import-uncorrelated-accounts source: | $Id = "75dbec1ebe154d5785da27b95e1dd5d7" # String | Source Id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -70982,14 +94422,39 @@ paths: # Process Uncorrelated Accounts try { - Import-V2024UncorrelatedAccounts -Id $Id -XSailPointExperimental $XSailPointExperimental + Import-V2025UncorrelatedAccounts -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Import-V2024UncorrelatedAccounts -Id $Id -XSailPointExperimental $XSailPointExperimental -File $File + # Import-V2025UncorrelatedAccounts -Id $Id -XSailPointExperimental $XSailPointExperimental -File $File } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024UncorrelatedAccounts" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025UncorrelatedAccounts" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/sources#import-uncorrelated-accounts + source: | + from sailpoint.v2025.api.sources_api import SourcesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.load_uncorrelated_accounts_task import LoadUncorrelatedAccountsTask + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '75dbec1ebe154d5785da27b95e1dd5d7' # str | Source Id # str | Source Id + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + file = None # bytearray | (optional) # bytearray | (optional) + try: + # Process Uncorrelated Accounts + + results = SourcesApi(api_client).import_uncorrelated_accounts(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = SourcesApi(api_client).import_uncorrelated_accounts(id, x_sail_point_experimental, file) + print("The response of SourcesApi->import_uncorrelated_accounts:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SourcesApi->import_uncorrelated_accounts: %s\n" % e) /task-status/{id}: get: tags: @@ -71023,23 +94488,23 @@ paths: application/json: schema: $ref: '#/paths/~1identities~1invite/post/responses/202/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/TaskStatus.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TaskStatus.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': description: Forbidden, generally due to a lack of security rights '404': description: TaskStatus with the given id was not found. '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:task-management:read @@ -71058,7 +94523,7 @@ paths: - SOURCE_SUBADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/task-management#get-task-status + label: SDK_tools/sdk/powershell/v2025/methods/task-management#get-task-status source: | $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -71066,14 +94531,38 @@ paths: # Get Task Status by ID try { - Get-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2025TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental + # Get-V2025TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaskStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TaskStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/task-management#get-task-status + source: | + from sailpoint.v2025.api.task_management_api import TaskManagementApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.task_status import TaskStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get Task Status by ID + + results = TaskManagementApi(api_client).get_task_status(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = TaskManagementApi(api_client).get_task_status(id, x_sail_point_experimental) + print("The response of TaskManagementApi->get_task_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling TaskManagementApi->get_task_status: %s\n" % e) patch: operationId: updateTaskStatus tags: @@ -71108,7 +94597,7 @@ paths: type: array items: $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/JsonPatchOperation.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml example: - op: replace path: /completionStatus @@ -71123,25 +94612,25 @@ paths: application/json: schema: $ref: '#/paths/~1identities~1invite/post/responses/202/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/TaskStatus.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TaskStatus.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:task-management:write @@ -71155,7 +94644,7 @@ paths: - SOURCE_SUBADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/task-management#update-task-status + label: SDK_tools/sdk/powershell/v2025/methods/task-management#update-task-status source: | $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -71170,14 +94659,40 @@ paths: try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + Update-V2025TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + # Update-V2025TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024TaskStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025TaskStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/task-management#update-task-status + source: | + from sailpoint.v2025.api.task_management_api import TaskManagementApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2025.models.task_status import TaskStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch_operation = '''[sailpoint.v2025.JsonPatchOperation()]''' # List[JsonPatchOperation] | The JSONPatch payload used to update the object. + try: + # Update Task Status by ID + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = TaskManagementApi(api_client).update_task_status(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = TaskManagementApi(api_client).update_task_status(id, x_sail_point_experimental, new_json_patch_operation) + print("The response of TaskManagementApi->update_task_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling TaskManagementApi->update_task_status: %s\n" % e) /task-status: get: tags: @@ -71187,12 +94702,12 @@ paths: Use this endpoint to get a list of statuses for **completed** tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. To get a list of statuses for **in-progress** tasks, please use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/v2024/get-pending-tasks) endpoint. operationId: getTaskStatusList parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - in: query name: filters schema: @@ -71239,25 +94754,25 @@ paths: type: array items: $ref: '#/paths/~1identities~1invite/post/responses/202/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/TaskStatus.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TaskStatus.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:task-management:read @@ -71276,7 +94791,7 @@ paths: - SOURCE_SUBADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/task-management#get-task-status-list + label: SDK_tools/sdk/powershell/v2025/methods/task-management#get-task-status-list source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $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) @@ -71288,14 +94803,42 @@ paths: # Retrieve Task Status List try { - Get-V2024TaskStatusList -XSailPointExperimental $XSailPointExperimental + Get-V2025TaskStatusList -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024TaskStatusList -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + # Get-V2025TaskStatusList -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaskStatusList" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TaskStatusList" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/task-management#get-task-status-list + source: | + from sailpoint.v2025.api.task_management_api import TaskManagementApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.task_status import TaskStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + filters = 'completionStatus eq \"Success\"' # 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: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (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: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (optional) + sorters = '-created' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created** (optional) + try: + # Retrieve Task Status List + + results = TaskManagementApi(api_client).get_task_status_list(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = TaskManagementApi(api_client).get_task_status_list(x_sail_point_experimental, limit, offset, count, filters, sorters) + print("The response of TaskManagementApi->get_task_status_list:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling TaskManagementApi->get_task_status_list: %s\n" % e) /task-status/pending-tasks: get: tags: @@ -71305,11 +94848,11 @@ paths: operationId: getPendingTasks parameters: - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - name: X-SailPoint-Experimental in: header description: Use this header to enable this experimental API. @@ -71327,25 +94870,25 @@ paths: type: array items: $ref: '#/paths/~1identities~1invite/post/responses/202/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/TaskStatus.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/TaskStatus.yaml '204': $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/204.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:task-management:read @@ -71364,7 +94907,7 @@ paths: - SOURCE_SUBADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/task-management#get-pending-tasks + label: SDK_tools/sdk/powershell/v2025/methods/task-management#get-pending-tasks source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $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) @@ -71374,14 +94917,40 @@ paths: # Retrieve Pending Task Status List try { - Get-V2024PendingTasks -XSailPointExperimental $XSailPointExperimental + Get-V2025PendingTasks -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024PendingTasks -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count + # Get-V2025PendingTasks -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingTasks" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PendingTasks" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/task-management#get-pending-tasks + source: | + from sailpoint.v2025.api.task_management_api import TaskManagementApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.task_status import TaskStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + 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) + 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: + # Retrieve Pending Task Status List + + results = TaskManagementApi(api_client).get_pending_tasks(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = TaskManagementApi(api_client).get_pending_tasks(x_sail_point_experimental, offset, limit, count) + print("The response of TaskManagementApi->get_pending_tasks:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling TaskManagementApi->get_pending_tasks: %s\n" % e) head: tags: - Task Management @@ -71390,11 +94959,11 @@ paths: operationId: getPendingTaskHeaders parameters: - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - name: X-SailPoint-Experimental in: header description: Use this header to enable this experimental API. @@ -71408,22 +94977,22 @@ paths: description: Retrieve headers for a list of TaskStatus for pending tasks. '204': $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/204.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:task-management:read @@ -71442,7 +95011,7 @@ paths: - SOURCE_SUBADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/task-management#get-pending-task-headers + label: SDK_tools/sdk/powershell/v2025/methods/task-management#get-pending-task-headers source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $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) @@ -71452,14 +95021,37 @@ paths: # Retrieve Pending Task List Headers try { - Get-V2024PendingTaskHeaders -XSailPointExperimental $XSailPointExperimental + Get-V2025PendingTaskHeaders -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024PendingTaskHeaders -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count + # Get-V2025PendingTaskHeaders -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingTaskHeaders" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PendingTaskHeaders" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/task-management#get-pending-task-headers + source: | + from sailpoint.v2025.api.task_management_api import TaskManagementApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + 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) + 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: + # Retrieve Pending Task List Headers + + TaskManagementApi(api_client).get_pending_task_headers(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # TaskManagementApi(api_client).get_pending_task_headers(x_sail_point_experimental, offset, limit, count) + except Exception as e: + print("Exception when calling TaskManagementApi->get_pending_task_headers: %s\n" % e) /tenant: get: operationId: getTenant @@ -71605,38 +95197,429 @@ paths: example: test '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/tenant#get-tenant + label: SDK_tools/sdk/powershell/v2025/methods/tenant#get-tenant source: | # Get Tenant Information. try { - Get-V2024Tenant + Get-V2025Tenant # Below is a request that includes all optional parameters - # Get-V2024Tenant + # Get-V2025Tenant } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Tenant" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Tenant" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/tenant#get-tenant + source: | + from sailpoint.v2025.api.tenant_api import TenantApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.tenant import Tenant + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get Tenant Information. + + results = TenantApi(api_client).get_tenant() + # Below is a request that includes all optional parameters + # results = TenantApi(api_client).get_tenant() + print("The response of TenantApi->get_tenant:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling TenantApi->get_tenant: %s\n" % e) + /tenant-context: + get: + summary: Retrieve tenant context + tags: + - Tenant Context + description: | + Returns a list of key-value pairs representing the current state of the tenant's context. + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + security: + - userAuth: + - idn:tenant-context:read + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN + operationId: getTenantContext + responses: + '200': + description: Successfully retrieved tenant context. + content: + application/json: + schema: + type: array + items: + type: object + properties: + key: + type: string + value: + type: string + example: + - key: IAS + value: International Accounting Standards + '400': + description: Client Error - Returned if the request body is invalid. + content: + application/json: + schema: + $ref: '#/paths/~1tenant-context/patch/responses/400/content/application~1json/schema' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ErrorResponseDto.yaml + '401': + description: Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. + content: + application/json: + schema: + type: object + properties: + error: + description: A message describing the error + example: 'JWT validation failed: JWT is expired' + '403': + description: Forbidden - Returned if the user you are running as, doesn't have access to this end-point. + content: + application/json: + schema: + $ref: '#/paths/~1tenant-context/patch/responses/400/content/application~1json/schema' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ErrorResponseDto.yaml + examples: + '403': + summary: An example of a 403 response object + value: + detailCode: 403 Forbidden + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server understood the request but refuses to authorize it. + '429': + description: 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. + content: + application/json: + schema: + type: object + properties: + message: + description: A message describing the error + example: ' Rate Limit Exceeded ' + '500': + description: Internal Server Error - Returned if there is an unexpected error. + content: + application/json: + schema: + $ref: '#/paths/~1tenant-context/patch/responses/400/content/application~1json/schema' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ErrorResponseDto.yaml + examples: + '500': + summary: An example of a 500 response object + value: + detailCode: 500.0 Internal Fault + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: An internal fault occurred. + x-codeSamples: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/tenant-context#get-tenant-context + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Retrieve tenant context + + try { + Get-V2025TenantContext -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025TenantContext -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TenantContext" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/tenant-context#get-tenant-context + source: | + from sailpoint.v2025.api.tenant_context_api import TenantContextApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.get_tenant_context200_response_inner import GetTenantContext200ResponseInner + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Retrieve tenant context + + results = TenantContextApi(api_client).get_tenant_context(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = TenantContextApi(api_client).get_tenant_context(x_sail_point_experimental) + print("The response of TenantContextApi->get_tenant_context:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling TenantContextApi->get_tenant_context: %s\n" % e) + patch: + summary: Update tenant context + tags: + - Tenant Context + description: | + Allows the user to make incremental updates to tenant context records using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + + This endpoint is specifically designed to modify the `/Key/*` field, supporting operations such as `add`, `remove`, or `replace` to manage key-value pairs. + + Note that each tenant is limited to a maximum of 100 key-value pairs. + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + security: + - userAuth: + - idn:tenant-context:write + x-sailpoint-userLevels: + - ORG_ADMIN + - SOURCE_ADMIN + - SOURCE_SUBADMIN + operationId: patchTenantContext + requestBody: + content: + application/json-patch+json: + schema: + $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml + examples: + Multiple operations in one call: + description: This example shows how multiple context keys may be updated with a single patch call. + value: + - op: add + path: /Key/IAS + value: Integrated Automation System + - op: replace + path: /Key/IAS + value: International Accounting Standards + - op: remove + path: /Key/NDR + Add a single context: + description: This example shows how a single context may be created with a single patch call. + value: + - op: add + path: /Key/IAS + value: Integrated Automation System + Update a single context: + description: This example shows how a single context may be updated with a single patch call. + value: + - op: replace + path: /Key/IAS + value: International Accounting Standards + Remove a single context: + description: This example shows how a single context may be removed with a single patch call. + value: + - op: remove + path: /Key/IAS + required: true + responses: + '200': + description: Tenant context updated successfully. + '400': + description: Bad request due to invalid input parameters. + content: + application/json: + schema: + type: object + properties: + detailCode: + type: string + description: Fine-grained error code providing more detail of the error. + example: 400.1 Bad Request Content + trackingId: + type: string + description: Unique tracking id for the error. + example: e7eab60924f64aa284175b9fa3309599 + messages: + type: array + description: Generic localized reason for error + items: + type: object + properties: + locale: + type: string + description: The locale for the message text, a BCP 47 language tag. + example: en-US + nullable: true + localeOrigin: + type: string + enum: + - DEFAULT + - REQUEST + - null + description: An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. + example: DEFAULT + nullable: true + text: + type: string + description: Actual text of the error message in the indicated locale. + example: The request was syntactically correct but its content is semantically invalid. + causes: + type: array + description: Plain-text descriptive reasons to provide additional detail to the text provided in the messages field + items: + $ref: '#/paths/~1tenant-context/patch/responses/400/content/application~1json/schema/properties/messages/items' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ErrorMessageDto.yaml + examples: + incorrectPath: + summary: Invalid Path Example + value: + detailCode: Bad Request + trackingId: e9eaaeac516643ffa087cc476e7577c5 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: 'invalid patch request: field not patchable or does not contain key (/InvalidPath/IAS)' + invalidOperation: + summary: Invalid Operation Example + value: + detailCode: Bad Request + trackingId: 39cfb6a29d5a4522954d72124545d3c5 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: 'invalid patch request: operation not allowed (move)' + noKeyInPath: + summary: No Key in Path Example + value: + detailCode: Bad Request + trackingId: 6d3bdd67ac8a4382884875ed4abf1f13 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: 'invalid patch request: field not patchable or does not contain key (/Key/)' + capacityExceeded: + summary: Capacity Exceeded Example + value: + detailCode: Bad Request + trackingId: bd51a5e2f4ee4d5aa65ac2f7cd3c2445 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: 'unable to fulfill patch request: max tenant context capacity exceeded by 5 key/value pair(s)' + '401': + $ref: '#/paths/~1tenant-context/get/responses/401' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + '403': + $ref: '#/paths/~1tenant-context/get/responses/403' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + '404': + description: Not Found - returned if the request URL refers to a resource or object that does not exist + content: + application/json: + schema: + $ref: '#/paths/~1tenant-context/patch/responses/400/content/application~1json/schema' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ErrorResponseDto.yaml + examples: + '404': + summary: An example of a 404 response object + value: + detailCode: 404 Not found + trackingId: b21b1f7ce4da4d639f2c62a57171b427 + messages: + - locale: en-US + localeOrigin: DEFAULT + text: The server did not find a current representation for the target resource. + '429': + $ref: '#/paths/~1tenant-context/get/responses/429' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + '500': + $ref: '#/paths/~1tenant-context/get/responses/500' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-codeSamples: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/tenant-context#patch-tenant-context + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @" + { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } + "@ + + # Update tenant context + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025TenantContext -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025TenantContext -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025TenantContext" + Write-Host $_.ErrorDetails + } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/tenant-context#patch-tenant-context + source: | + from sailpoint.v2025.api.tenant_context_api import TenantContextApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch_operation = '''{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }''' # JsonPatchOperation | + try: + # Update tenant context + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + TenantContextApi(api_client).patch_tenant_context(x_sail_point_experimental=x_sail_point_experimental, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # TenantContextApi(api_client).patch_tenant_context(x_sail_point_experimental, new_json_patch_operation) + except Exception as e: + print("Exception when calling TenantContextApi->patch_tenant_context: %s\n" % e) /triggers: get: operationId: listTriggers @@ -71645,12 +95628,12 @@ paths: summary: List Triggers description: Gets a list of triggers that are available in the tenant. parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - in: query name: filters required: false @@ -71724,429 +95707,14 @@ paths: exampleInput: description: An example of the JSON payload that will be sent by the trigger to the subscribed service. oneOf: - - title: Access Request Dynamic Approver - type: object - required: - - accessRequestId - - requestedFor - - requestedItems - - requestedBy - properties: - accessRequestId: - type: string - description: | - The unique ID of the access request object. Can be used with the [access request status endpoint](https://developer.sailpoint.com/idn/api/beta/list-access-request-status) to get the status of the request. - example: 4b4d982dddff4267ab12f0f1e72b5a6d - requestedFor: - type: array - description: Identities access was requested for. - items: - type: object - description: Identity the access item is requested for. - properties: - type: - type: string - description: DTO type of identity the access item is requested for. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: ID of identity the access item is requested for. - example: 2c4180a46faadee4016fb4e018c20626 - name: - type: string - description: Human-readable display name of identity the access item is requested for. - example: Robert Robinson - minItems: 1 - maxItems: 10 - requestedItems: - description: The access items that are being requested. - type: array - items: - type: object - required: - - id - - name - - type - - operation - properties: - id: - type: string - description: The unique ID of the access item. - example: 2c91808b6ef1d43e016efba0ce470904 - name: - type: string - description: Human friendly name of the access item. - example: Engineering Access - description: - nullable: true - type: string - description: Extended description of the access item. - example: Engineering Access - type: - enum: - - ACCESS_PROFILE - - ROLE - - ENTITLEMENT - description: The type of access item being requested. - example: ACCESS_PROFILE - operation: - enum: - - Add - - Remove - description: Grant or revoke the access item - example: Add - comment: - nullable: true - type: string - description: A comment from the requestor on why the access is needed. - example: William needs this access for his day to day job activities. - minItems: 1 - maxItems: 25 - requestedBy: - allOf: - - type: object - description: Access item requester's identity. - properties: - type: - type: string - description: Access item requester's DTO type. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: Access item requester's identity ID. - example: 2c7180a46faadee4016fb4e018c20648 - name: - type: string - description: Access item owner's human-readable display name. - example: William Wilson - - title: Access Request Post Approval - type: object - required: - - accessRequestId - - requestedFor - - requestedItemsStatus - - requestedBy - properties: - accessRequestId: - type: string - description: The unique ID of the access request. - example: 2c91808b6ef1d43e016efba0ce470904 - requestedFor: - required: - - id - - type - - name - type: array - description: Identities access was requested for. - items: - $ref: '#/paths/~1triggers/get/responses/200/content/application~1json/schema/items/properties/exampleInput/oneOf/0/properties/requestedFor/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/trigger/example-input/AccessItemRequestedForDto.yaml - minItems: 1 - maxItems: 10 - requestedItemsStatus: - description: Details on the outcome of each access item. - type: array - items: - type: object - required: - - id - - name - - type - - operation - - approvalInfo - properties: - id: - type: string - description: The unique ID of the access item being requested. - example: 2c91808b6ef1d43e016efba0ce470904 - name: - type: string - description: The human friendly name of the access item. - example: Engineering Access - description: - nullable: true - type: string - description: Detailed description of the access item. - example: Access to engineering database - type: - enum: - - ACCESS_PROFILE - - ROLE - - ENTITLEMENT - description: The type of access item. - example: ACCESS_PROFILE - operation: - enum: - - Add - - Remove - description: The action to perform on the access item. - example: Add - comment: - nullable: true - type: string - description: A comment from the identity requesting the access. - example: William needs this access to do his job. - clientMetadata: - description: Additional customer defined metadata about the access item. - nullable: true - type: object - additionalProperties: true - example: - applicationName: My application - approvalInfo: - description: A list of one or more approvers for the access request. - type: array - items: - type: object - required: - - approvalDecision - - approverName - - approver - properties: - approvalComment: - nullable: true - type: string - description: A comment left by the approver. - example: This access looks good. Approved. - approvalDecision: - enum: - - APPROVED - - DENIED - description: The final decision of the approver. - example: APPROVED - approverName: - type: string - description: The name of the approver - example: Stephen.Austin - approver: - required: - - id - - type - - name - allOf: - - type: object - description: Identity who approved the access item request. - properties: - type: - type: string - description: DTO type of identity who approved the access item request. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: ID of identity who approved the access item request. - example: 2c3780a46faadee4016fb4e018c20652 - name: - type: string - description: Human-readable display name of identity who approved the access item request. - example: Allen Albertson - description: The identity of the approver. - properties: - type: - enum: - - IDENTITY - example: IDENTITY - description: The type of object that is referenced - requestedBy: - required: - - id - - type - - name - allOf: - - $ref: '#/paths/~1triggers/get/responses/200/content/application~1json/schema/items/properties/exampleInput/oneOf/0/properties/requestedBy/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/trigger/example-input/AccessItemRequesterDto.yaml - - title: Access Request Pre Approval - type: object - required: - - accessRequestId - - requestedFor - - requestedItems - - requestedBy - properties: - accessRequestId: - type: string - description: The unique ID of the access request. - example: 2c91808b6ef1d43e016efba0ce470904 - requestedFor: - required: - - id - - type - - name - type: array - description: Identities access was requested for. - items: - $ref: '#/paths/~1triggers/get/responses/200/content/application~1json/schema/items/properties/exampleInput/oneOf/0/properties/requestedFor/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/trigger/example-input/AccessItemRequestedForDto.yaml - minItems: 1 - maxItems: 10 - requestedItems: - description: Details of the access items being requested. - type: array - items: - type: object - required: - - id - - name - - type - - operation - properties: - id: - type: string - description: The unique ID of the access item being requested. - example: 2c91808b6ef1d43e016efba0ce470904 - name: - type: string - description: The human friendly name of the access item. - example: Engineering Access - description: - nullable: true - type: string - description: Detailed description of the access item. - example: Access to engineering database - type: - enum: - - ACCESS_PROFILE - - ROLE - - ENTITLEMENT - description: The type of access item. - example: ACCESS_PROFILE - operation: - enum: - - Add - - Remove - description: The action to perform on the access item. - example: Add - comment: - nullable: true - type: string - description: A comment from the identity requesting the access. - example: William needs this access to do his job. - minItems: 1 - maxItems: 25 - requestedBy: - required: - - id - - type - - name - allOf: - - $ref: '#/paths/~1triggers/get/responses/200/content/application~1json/schema/items/properties/exampleInput/oneOf/0/properties/requestedBy/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/trigger/example-input/AccessItemRequesterDto.yaml - - title: Account Aggregation Completed - type: object - required: - - source - - status - - started - - completed - - errors - - warnings - - stats - properties: - source: - required: - - type - - name - - id - type: object - description: The source the accounts are being aggregated from. - properties: - type: - type: string - description: The DTO type of the source the accounts are being aggregated from. - enum: - - SOURCE - example: SOURCE - id: - type: string - description: The ID of the source the accounts are being aggregated from. - example: 2c9180835d191a86015d28455b4b232a - name: - type: string - description: Display name of the source the accounts are being aggregated from. - example: HR Active Directory - status: - description: The overall status of the aggregation. - enum: - - Success - - Failed - - Terminated - example: Success - started: - type: string - format: date-time - description: The date and time when the account aggregation started. - example: '2020-06-29T22:01:50.474Z' - completed: - type: string - format: date-time - description: The date and time when the account aggregation finished. - example: '2020-06-29T22:02:04.090Z' - errors: - nullable: true - description: A list of errors that occurred during the aggregation. - type: array - items: - type: string - description: A descriptive error message. - example: Accounts unable to be aggregated. - warnings: - nullable: true - description: A list of warnings that occurred during the aggregation. - type: array - items: - type: string - description: A descriptive warning message. - example: Account Skipped - stats: - type: object - description: Overall statistics about the account aggregation. - required: - - scanned - - unchanged - - changed - - added - - removed - properties: - scanned: - type: integer - format: int32 - minimum: 0 - maximum: 2147483647 - description: The number of accounts which were scanned / iterated over. - example: 200 - unchanged: - type: integer - format: int32 - minimum: 0 - maximum: 2147483647 - description: The number of accounts which existed before, but had no changes. - example: 190 - changed: - type: integer - format: int32 - minimum: 0 - maximum: 2147483647 - description: The number of accounts which existed before, but had changes. - example: 6 - added: - type: integer - format: int32 - minimum: 0 - maximum: 2147483647 - description: The number of accounts which are new - have not existed before. - example: 4 - removed: - type: integer - minimum: 0 - maximum: 2147483647 - format: int32 - description: The number accounts which existed before, but no longer exist (thus getting removed). - example: 3 + - $ref: '#/x-webhooks/AccessRequestDynamicApproval/post/requestBody/content/application~1json/schema' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/AccessRequestDynamicApprover.yaml + - $ref: '#/x-webhooks/AccessRequestDecision/post/requestBody/content/application~1json/schema' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/AccessRequestPostApproval.yaml + - $ref: '#/x-webhooks/AccessRequestSubmitted/post/requestBody/content/application~1json/schema' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/AccessRequestPreApproval.yaml + - $ref: '#/x-webhooks/AccountAggregationCompleted/post/requestBody/content/application~1json/schema' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/AccountAggregationCompleted.yaml - title: Account Attributes Changed type: object required: @@ -72565,1239 +96133,38 @@ paths: format: int32 description: The number of entitlements associated with this account. example: 0 - - title: Campaign Activated - type: object - required: - - campaign - properties: - campaign: - type: object - description: Details about the certification campaign that was activated. - required: - - id - - name - - description - - created - - deadline - - type - - campaignOwner - - status - properties: - id: - type: string - description: Unique ID for the campaign. - example: 2c91808576f886190176f88cac5a0010 - name: - type: string - description: The human friendly name of the campaign. - example: Manager Access Campaign - description: - type: string - description: Extended description of the campaign. - example: Audit access for all employees. - created: - type: string - format: date-time - description: The date and time the campaign was created. - example: '2021-02-16T03:04:45.815Z' - modified: - nullable: true - type: string - format: date-time - description: The date and time the campaign was last modified. - example: '2021-02-16T03:06:45.815Z' - deadline: - type: string - format: date-time - description: The date and time the campaign is due. - example: '2021-03-16T03:04:45.815Z' - type: - description: The type of campaign. - enum: - - MANAGER - - SOURCE_OWNER - - SEARCH - - ROLE_COMPOSITION - example: MANAGER - campaignOwner: - type: object - description: Details of the identity that owns the campaign. - required: - - id - - displayName - - email - properties: - id: - type: string - description: The unique ID of the identity. - example: 37f080867702c1910177031320c40n27 - displayName: - type: string - description: The human friendly name of the identity. - example: John Snow - email: - type: string - description: The primary email address of the identity. - example: john.snow@example.com - status: - enum: - - ACTIVE - description: The current status of the campaign. - example: ACTIVE - - title: Campaign Ended - type: object - required: - - campaign - properties: - campaign: - type: object - description: Details about the certification campaign that ended. - required: - - id - - name - - description - - created - - deadline - - type - - campaignOwner - - status - properties: - id: - type: string - description: Unique ID for the campaign. - example: 2c91808576f886190176f88cac5a0010 - name: - type: string - description: The human friendly name of the campaign. - example: Manager Access Campaign - description: - type: string - description: Extended description of the campaign. - example: Audit access for all employees. - created: - type: string - format: date-time - description: The date and time the campaign was created. - example: '2021-02-16T03:04:45.815Z' - modified: - nullable: true - type: string - format: date-time - description: The date and time the campaign was last modified. - example: '2021-03-16T03:06:45.815Z' - deadline: - type: string - format: date-time - description: The date and time the campaign is due. - example: '2021-03-16T03:04:45.815Z' - type: - description: The type of campaign. - enum: - - MANAGER - - SOURCE_OWNER - - SEARCH - - ROLE_COMPOSITION - example: MANAGER - campaignOwner: - type: object - description: Details of the identity that owns the campaign. - required: - - id - - displayName - - email - properties: - id: - type: string - description: The unique ID of the identity. - example: 37f080867702c1910177031320c40n27 - displayName: - type: string - description: The human friendly name of the identity. - example: John Snow - email: - type: string - description: The primary email address of the identity. - example: john.snow@example.com - status: - enum: - - COMPLETED - description: The current status of the campaign. - example: COMPLETED - - title: Campaign Generated - type: object - required: - - campaign - properties: - campaign: - description: Details about the campaign that was generated. - type: object - required: - - id - - name - - description - - created - - type - - campaignOwner - - status - properties: - id: - type: string - description: The unique ID of the campaign. - example: 2c91808576f886190176f88cac5a0010 - name: - type: string - description: Human friendly name of the campaign. - example: Manager Access Campaign - description: - type: string - description: Extended description of the campaign. - example: Audit access for all employees. - created: - type: string - format: date-time - description: The date and time the campaign was created. - example: '2021-02-16T03:04:45.815Z' - modified: - nullable: true - type: string - description: The date and time the campaign was last modified. - example: '2021-02-17T03:04:45.815Z' - deadline: - nullable: true - type: string - description: The date and time when the campaign must be finished by. - example: '2021-02-18T03:04:45.815Z' - type: - enum: - - MANAGER - - SOURCE_OWNER - - SEARCH - - ROLE_COMPOSITION - description: The type of campaign that was generated. - example: MANAGER - campaignOwner: - type: object - description: The identity that owns the campaign. - required: - - id - - displayName - - email - properties: - id: - type: string - description: The unique ID of the identity. - example: 37f080867702c1910177031320c40n27 - displayName: - type: string - description: The display name of the identity. - example: John Snow - email: - type: string - description: The primary email address of the identity. - example: john.snow@example.com - status: - enum: - - STAGED - - ACTIVATING - - ACTIVE - description: The current status of the campaign. - example: STAGED - - title: Certification Signed Off - type: object - required: - - certification - properties: - certification: - description: The certification campaign that was signed off on. - required: - - id - - name - - created - allOf: - - type: object - required: - - campaignRef - - completed - - decisionsMade - - decisionsTotal - - due - - signed - - reviewer - - campaignOwner - - hasErrors - - phase - - entitiesCompleted - - entitiesTotal - properties: - campaignRef: - type: object - required: - - id - - name - - type - - campaignType - - description - - correlatedStatus - - mandatoryCommentRequirement - properties: - id: - type: string - description: The unique ID of the campaign. - example: ef38f94347e94562b5bb8424a56397d8 - name: - type: string - description: The name of the campaign. - example: Campaign Name - type: - type: string - enum: - - CAMPAIGN - description: The type of object that is being referenced. - example: CAMPAIGN - campaignType: - type: string - enum: - - MANAGER - - SOURCE_OWNER - - SEARCH - description: The type of the campaign. - example: MANAGER - description: - type: string - description: The description of the campaign set by the admin who created it. - nullable: true - example: A description of the campaign - correlatedStatus: - type: string - description: The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). - enum: - - CORRELATED - - UNCORRELATED - example: CORRELATED - mandatoryCommentRequirement: - type: string - description: Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. - enum: - - ALL_DECISIONS - - REVOKE_ONLY_DECISIONS - - NO_DECISIONS - example: NO_DECISIONS - phase: - type: string - description: | - The current phase of the campaign. - * `STAGED`: The campaign is waiting to be activated. - * `ACTIVE`: The campaign is active. - * `SIGNED`: The reviewer has signed off on the campaign, and it is considered complete. - enum: - - STAGED - - ACTIVE - - SIGNED - example: ACTIVE - due: - type: string - format: date-time - description: The due date of the certification. - example: '2018-10-19T13:49:37.385Z' - signed: - type: string - format: date-time - description: The date the reviewer signed off on the certification. - example: '2018-10-19T13:49:37.385Z' - reviewer: - $ref: '#/components/schemas/Certification/properties/reviewer' - description: A reference to the reviewer of the campaign. - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/Reviewer.yaml - reassignment: - $ref: '#/components/schemas/Certification/properties/reassignment' - nullable: true - description: A reference to a reviewer that this campaign has been reassigned to. - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/Reassignment.yaml - hasErrors: - type: boolean - example: false - description: Indicates it the certification has any errors. - errorMessage: - type: string - nullable: true - example: The certification has an error - description: A message indicating what the error is. - completed: - type: boolean - description: Indicates if all certification decisions have been made. - example: false - decisionsMade: - type: integer - description: The number of approve/revoke/acknowledge decisions that have been made by the reviewer. - example: 20 - format: int32 - decisionsTotal: - type: integer - description: The total number of approve/revoke/acknowledge decisions for the certification. - example: 40 - format: int32 - entitiesCompleted: - type: integer - description: The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete. - example: 5 - format: int32 - entitiesTotal: - type: integer - format: int32 - description: The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. - example: 10 - properties: - id: - type: string - description: Unique ID of the certification. - example: 2c91808576f886190176f88caf0d0067 - name: - type: string - description: The name of the certification. - example: Manager Access Review for Alice Baker - created: - type: string - format: date-time - description: The date and time the certification was created. - example: '2020-02-16T03:04:45.815Z' - modified: - nullable: true - type: string - format: date-time - description: The date and time the certification was last modified. - example: '2020-02-16T03:06:45.815Z' - - title: Identity Attributes Changed - type: object - required: - - identity - - changes - properties: - identity: - required: - - id - - type - - name - type: object - description: Identity whose attributes changed. - properties: - type: - type: string - description: DTO type of identity whose attributes changed. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: ID of identity whose attributes changed. - example: 2c7180a46faadee4016fb4e018c20642 - name: - type: string - description: Display name of identity whose attributes changed. - example: Michael Michaels - changes: - description: A list of one or more identity attributes that changed on the identity. - type: array - items: - type: object - required: - - attribute - properties: - attribute: - type: string - description: The name of the identity attribute that changed. - example: department - oldValue: - description: The value of the identity attribute before it changed. - nullable: true - example: sales - oneOf: - - type: string - - type: boolean - - type: array - items: - type: string - - type: object - nullable: true - additionalProperties: - oneOf: - - type: string - - type: number - - type: integer - - type: boolean - newValue: - description: The value of the identity attribute after it changed. - example: marketing - oneOf: - - type: string - - type: boolean - - type: array - items: - type: string - - type: object - nullable: true - additionalProperties: - oneOf: - - type: string - - type: number - - type: integer - - type: boolean - - title: Identity Created - type: object - required: - - identity - - attributes - properties: - identity: - required: - - id - - type - - name - type: object - description: Created identity. - properties: - type: - type: string - description: Created identity's DTO type. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: Created identity ID. - example: 2c7180a46faadee4016fb4e018c20642 - name: - type: string - description: Created identity's display name. - example: Michael Michaels - attributes: - type: object - description: The attributes assigned to the identity. Attributes are determined by the identity profile. - additionalProperties: true - example: - firstname: John - - title: Identity Deleted - type: object - required: - - identity - - attributes - properties: - identity: - required: - - id - - type - - name - type: object - description: Deleted identity. - properties: - type: - type: string - description: Deleted identity's DTO type. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: Deleted identity ID. - example: 2c7180a46faadee4016fb4e018c20642 - name: - type: string - description: Deleted identity's display name. - example: Michael Michaels - attributes: - type: object - description: The attributes assigned to the identity. Attributes are determined by the identity profile. - additionalProperties: true - example: - firstname: John - - title: Provisioning Completed - type: object - required: - - trackingNumber - - sources - - recipient - - accountRequests - properties: - trackingNumber: - type: string - description: The reference number of the provisioning request. Useful for tracking status in the Account Activity search interface. - example: 4b4d982dddff4267ab12f0f1e72b5a6d - sources: - type: string - description: One or more sources that the provisioning transaction(s) were done against. Sources are comma separated. - example: Corp AD, Corp LDAP, Corp Salesforce - action: - nullable: true - type: string - description: Origin of where the provisioning request came from. - example: IdentityRefresh - errors: - nullable: true - description: A list of any accumulated error messages that occurred during provisioning. - type: array - items: - type: string - example: Connector AD Failed - warnings: - nullable: true - description: A list of any accumulated warning messages that occurred during provisioning. - type: array - items: - type: string - example: Notification Skipped due to invalid email - recipient: - required: - - id - - type - - name - type: object - description: Provisioning recpient. - properties: - type: - type: string - description: Provisioning recipient DTO type. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: Provisioning recipient's identity ID. - example: 2c7180a46faadee4016fb4e018c20642 - name: - type: string - description: Provisioning recipient's display name. - example: Michael Michaels - requester: - nullable: true - required: - - id - - type - - name - type: object - description: Provisioning requester's identity. - properties: - type: - type: string - description: Provisioning requester's DTO type. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: Provisioning requester's identity ID. - example: 2c7180a46faadee4016fb4e018c20648 - name: - type: string - description: Provisioning owner's human-readable display name. - example: William Wilson - accountRequests: - type: array - description: A list of provisioning instructions to perform on an account-by-account basis. - items: - type: object - required: - - source - - accountOperation - - provisioningResult - - provisioningTarget - properties: - source: - required: - - id - - type - - name - type: object - description: Reference to the source being provisioned against. - properties: - id: - description: ID of the object to which this reference applies - type: string - example: 4e4d982dddff4267ab12f0f1e72b5a6d - type: - type: string - enum: - - SOURCE - example: SOURCE - description: The type of object that is referenced - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: Corporate Active Directory - accountId: - type: string - description: The unique idenfier of the account being provisioned. - example: CN=Chewy.Bacca,ou=hardcorefigter,ou=wookies,dc=starwars,dc=com - accountOperation: - type: string - description: The provisioning operation; typically Create, Modify, Enable, Disable, Unlock, or Delete. - example: Modify - provisioningResult: - description: The overall result of the provisioning transaction; this could be success, pending, failed, etc. - enum: - - SUCCESS - - PENDING - - FAILED - example: SUCCESS - provisioningTarget: - type: string - description: The name of the provisioning channel selected; this could be the same as the source, or could be a Service Desk Integration Module (SDIM). - example: Corp AD - ticketId: - nullable: true - type: string - description: A reference to a tracking number, if this is sent to a Service Desk Integration Module (SDIM). - example: '72619262' - attributeRequests: - nullable: true - description: A list of attributes as part of the provisioning transaction. - type: array - items: - type: object - required: - - attributeName - - operation - properties: - attributeName: - type: string - description: The name of the attribute being provisioned. - example: memberOf - attributeValue: - nullable: true - type: string - description: The value of the attribute being provisioned. - example: CN=jedi,DC=starwars,DC=com - operation: - enum: - - Add - - Set - - Remove - description: The operation to handle the attribute. - example: Add - - title: Saved Search Complete - type: object - required: - - fileName - - ownerEmail - - ownerName - - query - - searchName - - searchResults - - signedS3Url - properties: - fileName: - type: string - description: A name for the report file. - example: Modified.zip - ownerEmail: - type: string - description: The email address of the identity that owns the saved search. - example: test@sailpoint.com - ownerName: - type: string - description: The name of the identity that owns the saved search. - example: Cloud Support - query: - type: string - description: The search query that was used to generate the report. - example: modified:[now-7y/d TO now] - searchName: - type: string - description: The name of the saved search. - example: Modified Activity - searchResults: - type: object - description: A preview of the search results for each object type. This includes a count as well as headers, and the first several rows of data, per object type. - properties: - Account: - description: A table of accounts that match the search criteria. - nullable: true - type: object - required: - - count - - noun - - preview - properties: - count: - type: string - description: The number of rows in the table. - example: 3 - noun: - type: string - description: The type of object represented in the table. - example: accounts - preview: - description: A sample of the data in the table. - type: array - items: - type: array - items: - type: string - example: Robert.Chase - example: [] - Entitlement: - description: A table of entitlements that match the search criteria. - nullable: true - type: object - required: - - count - - noun - - preview - properties: - count: - type: string - description: The number of rows in the table. - example: 2 - noun: - type: string - description: The type of object represented in the table. - example: entitlements - preview: - description: A sample of the data in the table. - type: array - items: - type: array - items: - type: string - example: Administrator - example: [] - Identity: - description: A table of identities that match the search criteria. - nullable: true - type: object - required: - - count - - noun - - preview - properties: - count: - type: string - description: The number of rows in the table. - example: 2 - noun: - type: string - description: The type of object represented in the table. - example: identities - preview: - description: A sample of the data in the table. - type: array - items: - type: array - items: - type: string - example: Carol Shelby - example: [] - signedS3Url: - type: string - description: The Amazon S3 URL to download the report from. - example: https://sptcbu-org-data-useast1.s3.amazonaws.com/arsenal-john/reports/Events%20Export.2020-05-06%2018%2759%20GMT.3e580592-86e4-4953-8aea-49e6ef20a086.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200506T185919Z&X-Amz-SignedHeaders=host&X-Amz-Expires=899&X-Amz-Credential=AKIAV5E54XOGTS4Q4L7A%2F20200506%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=2e732bb97a12a1fd8a215613e3c31fcdae8ba1fb6a25916843ab5b51d2ddefbc - - title: Source Account Created - type: object - required: - - id - - nativeIdentifier - - sourceId - - sourceName - - identityId - - identityName - - attributes - properties: - uuid: - type: string - description: Source unique identifier for the identity. UUID is generated by the source system. - example: b7264868-7201-415f-9118-b581d431c688 - id: - type: string - description: SailPoint generated unique identifier. - example: ee769173319b41d19ccec35ba52f237b - nativeIdentifier: - type: string - description: Unique ID of the account on the source. - example: E009 - sourceId: - type: string - description: The ID of the source. - example: 2c918082814e693601816e09471b29b6 - sourceName: - type: string - description: The name of the source. - example: Active Directory - identityId: - type: string - description: The ID of the identity that is correlated with this account. - example: ee769173319b41d19ccec6c235423237b - identityName: - type: string - description: The name of the identity that is correlated with this account. - example: john.doe - attributes: - type: object - additionalProperties: true - description: The attributes of the account. The contents of attributes depends on the account schema for the source. - example: - firstname: John - lastname: Doe - email: john.doe@gmail.com - department: Sales - displayName: John Doe - created: '2020-04-27T16:48:33.597Z' - employeeNumber: E009 - uid: E009 - inactive: 'true' - phone: null - identificationNumber: E009 - - title: Source Account Deleted - type: object - required: - - id - - nativeIdentifier - - sourceId - - sourceName - - identityId - - identityName - - attributes - properties: - uuid: - type: string - description: Source unique identifier for the identity. UUID is generated by the source system. - example: b7264868-7201-415f-9118-b581d431c688 - id: - type: string - description: SailPoint generated unique identifier. - example: ee769173319b41d19ccec35ba52f237b - nativeIdentifier: - type: string - description: Unique ID of the account on the source. - example: E009 - sourceId: - type: string - description: The ID of the source. - example: 2c918082814e693601816e09471b29b6 - sourceName: - type: string - description: The name of the source. - example: Active Directory - identityId: - type: string - description: The ID of the identity that is correlated with this account. - example: ee769173319b41d19ccec6c235423237b - identityName: - type: string - description: The name of the identity that is correlated with this account. - example: john.doe - attributes: - type: object - additionalProperties: true - description: The attributes of the account. The contents of attributes depends on the account schema for the source. - example: - firstname: John - lastname: Doe - email: john.doe@gmail.com - department: Sales - displayName: John Doe - created: '2020-04-27T16:48:33.597Z' - employeeNumber: E009 - uid: E009 - inactive: 'true' - phone: null - identificationNumber: E009 - - title: Source Account Updated - type: object - required: - - id - - nativeIdentifier - - sourceId - - sourceName - - identityId - - identityName - - attributes - properties: - uuid: - type: string - description: Source unique identifier for the identity. UUID is generated by the source system. - example: b7264868-7201-415f-9118-b581d431c688 - id: - type: string - description: SailPoint generated unique identifier. - example: ee769173319b41d19ccec35ba52f237b - nativeIdentifier: - type: string - description: Unique ID of the account on the source. - example: E009 - sourceId: - type: string - description: The ID of the source. - example: 2c918082814e693601816e09471b29b6 - sourceName: - type: string - description: The name of the source. - example: Active Directory - identityId: - type: string - description: The ID of the identity that is correlated with this account. - example: ee769173319b41d19ccec6c235423237b - identityName: - type: string - description: The name of the identity that is correlated with this account. - example: john.doe - attributes: - type: object - additionalProperties: true - description: The attributes of the account. The contents of attributes depends on the account schema for the source. - example: - firstname: John - lastname: Doe - email: john.doe@gmail.com - department: Sales - displayName: John Doe - created: '2020-04-27T16:48:33.597Z' - employeeNumber: E009 - uid: E009 - inactive: 'true' - phone: null - identificationNumber: E009 - - title: Source Created - type: object - required: - - id - - name - - type - - created - - connector - - actor - properties: - id: - type: string - description: The unique ID of the source. - example: 2c9180866166b5b0016167c32ef31a66 - name: - type: string - description: Human friendly name of the source. - example: Test source - type: - type: string - description: The connection type. - example: DIRECT_CONNECT - created: - type: string - format: date-time - description: The date and time the source was created. - example: '2021-03-29T22:01:50.474Z' - connector: - type: string - description: The connector type used to connect to the source. - example: active-directory - actor: - required: - - id - - name - - type - type: object - description: Identity who created the source. - properties: - type: - type: string - description: DTO type of identity who created the source. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: ID of identity who created the source. - example: 2c7180a46faadee4016fb4e018c20648 - name: - type: string - description: Display name of identity who created the source. - example: William Wilson - - title: Source Deleted - type: object - required: - - id - - name - - type - - deleted - - connector - - actor - properties: - id: - type: string - description: The unique ID of the source. - example: 2c9180866166b5b0016167c32ef31a66 - name: - type: string - description: Human friendly name of the source. - example: Test source - type: - type: string - description: The connection type. - example: DIRECT_CONNECT - deleted: - type: string - format: date-time - description: The date and time the source was deleted. - example: '2021-03-29T22:01:50.474Z' - connector: - type: string - description: The connector type used to connect to the source. - example: active-directory - actor: - required: - - id - - name - - type - type: object - description: Identity who deleted the source. - properties: - type: - type: string - description: DTO type of identity who deleted the source. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: ID of identity who deleted the source. - example: 2c7180a46faadee4016fb4e018c20648 - name: - type: string - description: Display name of identity who deleted the source. - example: William Wilson - - title: Source Updated - type: object - required: - - id - - name - - type - - modified - - connector - - actor - properties: - id: - type: string - description: The unique ID of the source. - example: 2c9180866166b5b0016167c32ef31a66 - name: - type: string - description: The user friendly name of the source. - example: Corporate Active Directory - type: - type: string - description: The connection type of the source. - example: DIRECT_CONNECT - modified: - type: string - format: date-time - description: The date and time the source was modified. - example: '2021-03-29T22:01:50.474Z' - connector: - type: string - description: The connector type used to connect to the source. - example: active-directory - actor: - required: - - type - - name - type: object - description: Identity who updated the source. - properties: - type: - type: string - description: DTO type of identity who updated the source. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: ID of identity who updated the source. - example: 2c7180a46faadee4016fb4e018c20648 - name: - type: string - description: Display name of identity who updated the source. - example: William Wilson - - title: VA Cluster Status Change Event - type: object - required: - - created - - type - - application - - healthCheckResult - - previousHealthCheckResult - properties: - created: - type: string - format: date-time - description: The date and time the status change occurred. - example: '2020-06-29T22:01:50.474Z' - type: - enum: - - SOURCE - - CLUSTER - description: The type of the object that initiated this event. - example: CLUSTER - application: - type: object - description: Details about the `CLUSTER` or `SOURCE` that initiated this event. - required: - - id - - name - - attributes - properties: - id: - type: string - description: The GUID of the application - example: 2c9180866166b5b0016167c32ef31a66 - name: - type: string - description: The name of the application - example: Production VA Cluster - attributes: - type: object - description: Custom map of attributes for a source. This will only be populated if type is `SOURCE` and the source has a proxy. - additionalProperties: true - nullable: true - example: null - healthCheckResult: - type: object - description: The results of the most recent health check. - required: - - message - - resultType - - status - properties: - message: - type: string - description: Detailed message of the result of the health check. - example: Test Connection failed with exception. Error message - java.lang Exception - resultType: - type: string - description: The type of the health check result. - example: SOURCE_STATE_ERROR_CLUSTER - status: - enum: - - Succeeded - - Failed - description: The status of the health check. - example: Succeeded - previousHealthCheckResult: - type: object - description: The results of the last health check. - required: - - message - - resultType - - status - properties: - message: - type: string - description: Detailed message of the result of the health check. - example: Test Connection failed with exception. Error message - java.lang Exception - resultType: - type: string - description: The type of the health check result. - example: SOURCE_STATE_ERROR_CLUSTER - status: - enum: - - Succeeded - - Failed - description: The status of the health check. - example: Failed + - $ref: '#/x-webhooks/CampaignActivated/post/requestBody/content/application~1json/schema' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/CampaignActivated.yaml + - $ref: '#/x-webhooks/CampaignEnded/post/requestBody/content/application~1json/schema' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/CampaignEnded.yaml + - $ref: '#/x-webhooks/CampaignGenerated/post/requestBody/content/application~1json/schema' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/CampaignGenerated.yaml + - $ref: '#/x-webhooks/CertificationSignedOff/post/requestBody/content/application~1json/schema' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/CertificationSignedOff.yaml + - $ref: '#/x-webhooks/IdentityAttributesChanged/post/requestBody/content/application~1json/schema' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/IdentityAttributesChanged.yaml + - $ref: '#/x-webhooks/IdentityCreated/post/requestBody/content/application~1json/schema' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/IdentityCreated.yaml + - $ref: '#/x-webhooks/IdentityDeleted/post/requestBody/content/application~1json/schema' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/IdentityDeleted.yaml + - $ref: '#/x-webhooks/ProvisioningCompleted/post/requestBody/content/application~1json/schema' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/ProvisioningCompleted.yaml + - $ref: '#/x-webhooks/ScheduledSearch/post/requestBody/content/application~1json/schema' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/SavedSearchComplete.yaml + - $ref: '#/x-webhooks/NativeChangeAccountCreated/post/requestBody/content/application~1json/schema' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/SourceAccountCreated.yaml + - $ref: '#/x-webhooks/NativeChangeAccountDeleted/post/requestBody/content/application~1json/schema' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/SourceAccountDeleted.yaml + - $ref: '#/x-webhooks/NativeChangeAccountUpdated/post/requestBody/content/application~1json/schema' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/SourceAccountUpdated.yaml + - $ref: '#/x-webhooks/SourceCreated/post/requestBody/content/application~1json/schema' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/SourceCreated.yaml + - $ref: '#/x-webhooks/SourceDeleted/post/requestBody/content/application~1json/schema' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/SourceDeleted.yaml + - $ref: '#/x-webhooks/SourceUpdated/post/requestBody/content/application~1json/schema' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/SourceUpdated.yaml + - $ref: '#/x-webhooks/VaClusterStatusChange/post/requestBody/content/application~1json/schema' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/trigger/example-input/VAClusterStatusChangeEvent.yaml outputSchema: type: string description: The JSON schema of the response that will be sent by the subscribed service to the trigger in response to an event. This only applies to a trigger type of `REQUEST_RESPONSE`. @@ -73850,25 +96217,25 @@ paths: example: AcmeCorpExternalIntegration '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - sp:trigger-service-subscriptions:read x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/triggers#list-triggers + label: SDK_tools/sdk/powershell/v2025/methods/triggers#list-triggers source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $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) @@ -73880,14 +96247,42 @@ paths: # List Triggers try { - Get-V2024Triggers -XSailPointExperimental $XSailPointExperimental + Get-V2025Triggers -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024Triggers -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + # Get-V2025Triggers -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Triggers" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Triggers" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/triggers#list-triggers + source: | + from sailpoint.v2025.api.triggers_api import TriggersApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.trigger import Trigger + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + filters = 'id eq \"idn:access-request-post-approval\"' # 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: **id**: *eq, ge, le* (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: **id**: *eq, ge, le* (optional) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name** (optional) + try: + # List Triggers + + results = TriggersApi(api_client).list_triggers(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = TriggersApi(api_client).list_triggers(x_sail_point_experimental, limit, offset, count, filters, sorters) + print("The response of TriggersApi->list_triggers:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling TriggersApi->list_triggers: %s\n" % e) /trigger-subscriptions: post: operationId: createSubscription @@ -74103,7 +96498,7 @@ paths: example: Access Requested type: $ref: '#/paths/~1trigger-subscriptions/post/requestBody/content/application~1json/schema/properties/type' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/SubscriptionType.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SubscriptionType.yaml responseDeadline: type: string description: Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. @@ -74111,10 +96506,10 @@ paths: default: PT1H httpConfig: $ref: '#/paths/~1trigger-subscriptions/post/requestBody/content/application~1json/schema/properties/httpConfig' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/HttpConfig.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/HttpConfig.yaml eventBridgeConfig: $ref: '#/paths/~1trigger-subscriptions/post/requestBody/content/application~1json/schema/properties/eventBridgeConfig' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/EventBridgeConfig.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/EventBridgeConfig.yaml enabled: type: boolean description: |- @@ -74131,19 +96526,19 @@ paths: url: https://developer.sailpoint.com/idn/docs/event-triggers/filtering-events '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - sp:trigger-service-subscriptions:manage @@ -74158,7 +96553,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/triggers#create-subscription + label: SDK_tools/sdk/powershell/v2025/methods/triggers#create-subscription source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $SubscriptionPostRequest = @" @@ -74193,14 +96588,63 @@ paths: try { $Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest - New-V2024Subscription -XSailPointExperimental $XSailPointExperimental -SubscriptionPostRequest $Result + New-V2025Subscription -XSailPointExperimental $XSailPointExperimental -SubscriptionPostRequest $Result # Below is a request that includes all optional parameters - # New-V2024Subscription -XSailPointExperimental $XSailPointExperimental -SubscriptionPostRequest $Result + # New-V2025Subscription -XSailPointExperimental $XSailPointExperimental -SubscriptionPostRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Subscription" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Subscription" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/triggers#create-subscription + source: | + from sailpoint.v2025.api.triggers_api import TriggersApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.subscription import Subscription + from sailpoint.v2025.models.subscription_post_request import SubscriptionPostRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + subscription_post_request = '''{ + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "httpConfig" : { + "bearerTokenAuthConfig" : { + "bearerToken" : "bearerToken" + }, + "httpAuthenticationType" : "BASIC_AUTH", + "httpDispatchMode" : "SYNC", + "basicAuthConfig" : { + "password" : "password", + "userName" : "user@example.com" + }, + "url" : "https://www.example.com" + }, + "triggerId" : "idn:access-requested", + "name" : "Access request subscription", + "description" : "Access requested to site xyz", + "eventBridgeConfig" : { + "awsRegion" : "us-west-1", + "awsAccount" : "123456789012" + }, + "responseDeadline" : "PT1H", + "type" : "HTTP", + "enabled" : true + }''' # SubscriptionPostRequest | + try: + # Create a Subscription + new_subscription_post_request = SubscriptionPostRequest.from_json(subscription_post_request) + results = TriggersApi(api_client).create_subscription(x_sail_point_experimental=x_sail_point_experimental, subscription_post_request=new_subscription_post_request) + # Below is a request that includes all optional parameters + # results = TriggersApi(api_client).create_subscription(x_sail_point_experimental, new_subscription_post_request) + print("The response of TriggersApi->create_subscription:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling TriggersApi->create_subscription: %s\n" % e) get: operationId: listSubscriptions tags: @@ -74208,12 +96652,12 @@ paths: summary: List Subscriptions description: Gets a list of all trigger subscriptions. parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - in: query required: false name: filters @@ -74258,7 +96702,7 @@ paths: type: array items: $ref: '#/paths/~1trigger-subscriptions/post/responses/201/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/Subscription.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Subscription.yaml examples: HTTP Subscription: value: @@ -74309,25 +96753,25 @@ paths: filter: $[?($.identityId == "201327fda1c44704ac01181e963d463c")] '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - sp:trigger-service-subscriptions:read x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/triggers#list-subscriptions + label: SDK_tools/sdk/powershell/v2025/methods/triggers#list-subscriptions source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $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) @@ -74339,14 +96783,42 @@ paths: # List Subscriptions try { - Get-V2024Subscriptions -XSailPointExperimental $XSailPointExperimental + Get-V2025Subscriptions -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024Subscriptions -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + # Get-V2025Subscriptions -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Subscriptions" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Subscriptions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/triggers#list-subscriptions + source: | + from sailpoint.v2025.api.triggers_api import TriggersApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.subscription import Subscription + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + filters = 'id eq \"12cff757-c0c0-413b-8ad7-2a47956d1e89\"' # 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: **id**: *eq* **triggerId**: *eq* **type**: *eq, le* (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: **id**: *eq* **triggerId**: *eq* **type**: *eq, le* (optional) + sorters = 'triggerName' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, triggerName** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, triggerName** (optional) + try: + # List Subscriptions + + results = TriggersApi(api_client).list_subscriptions(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = TriggersApi(api_client).list_subscriptions(x_sail_point_experimental, limit, offset, count, filters, sorters) + print("The response of TriggersApi->list_subscriptions:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling TriggersApi->list_subscriptions: %s\n" % e) /trigger-subscriptions/{id}: put: operationId: updateSubscription @@ -74398,7 +96870,7 @@ paths: example: Access requested to site xyz type: $ref: '#/paths/~1trigger-subscriptions/post/requestBody/content/application~1json/schema/properties/type' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/SubscriptionType.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/SubscriptionType.yaml responseDeadline: type: string description: Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. @@ -74406,10 +96878,10 @@ paths: default: PT1H httpConfig: $ref: '#/paths/~1trigger-subscriptions/post/requestBody/content/application~1json/schema/properties/httpConfig' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/HttpConfig.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/HttpConfig.yaml eventBridgeConfig: $ref: '#/paths/~1trigger-subscriptions/post/requestBody/content/application~1json/schema/properties/eventBridgeConfig' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/EventBridgeConfig.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/EventBridgeConfig.yaml enabled: type: boolean description: |- @@ -74472,31 +96944,31 @@ paths: application/json: schema: $ref: '#/paths/~1trigger-subscriptions/post/responses/201/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/Subscription.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Subscription.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - sp:trigger-service-subscriptions:manage x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/triggers#update-subscription + label: SDK_tools/sdk/powershell/v2025/methods/triggers#update-subscription source: | $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -74531,14 +97003,63 @@ paths: try { $Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest - Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPutRequest $Result + Update-V2025Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPutRequest $Result # Below is a request that includes all optional parameters - # Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPutRequest $Result + # Update-V2025Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPutRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Subscription" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Subscription" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/triggers#update-subscription + source: | + from sailpoint.v2025.api.triggers_api import TriggersApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.subscription import Subscription + from sailpoint.v2025.models.subscription_put_request import SubscriptionPutRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + subscription_put_request = '''{ + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "httpConfig" : { + "bearerTokenAuthConfig" : { + "bearerToken" : "bearerToken" + }, + "httpAuthenticationType" : "BASIC_AUTH", + "httpDispatchMode" : "SYNC", + "basicAuthConfig" : { + "password" : "password", + "userName" : "user@example.com" + }, + "url" : "https://www.example.com" + }, + "name" : "Access request subscription", + "description" : "Access requested to site xyz", + "eventBridgeConfig" : { + "awsRegion" : "us-west-1", + "awsAccount" : "123456789012" + }, + "responseDeadline" : "PT1H", + "type" : "HTTP", + "enabled" : true + }''' # SubscriptionPutRequest | + try: + # Update a Subscription + new_subscription_put_request = SubscriptionPutRequest.from_json(subscription_put_request) + results = TriggersApi(api_client).update_subscription(id=id, x_sail_point_experimental=x_sail_point_experimental, subscription_put_request=new_subscription_put_request) + # Below is a request that includes all optional parameters + # results = TriggersApi(api_client).update_subscription(id, x_sail_point_experimental, new_subscription_put_request) + print("The response of TriggersApi->update_subscription:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling TriggersApi->update_subscription: %s\n" % e) patch: operationId: patchSubscription tags: @@ -74620,31 +97141,31 @@ paths: application/json: schema: $ref: '#/paths/~1trigger-subscriptions/post/responses/201/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/Subscription.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Subscription.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - sp:trigger-service-subscriptions:manage x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/triggers#patch-subscription + label: SDK_tools/sdk/powershell/v2025/methods/triggers#patch-subscription source: | $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | ID of the Subscription to patch $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -74655,14 +97176,40 @@ paths: try { $Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner - Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPatchRequestInner $Result + Update-V2025Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPatchRequestInner $Result # Below is a request that includes all optional parameters - # Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPatchRequestInner $Result + # Update-V2025Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPatchRequestInner $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Subscription" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Subscription" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/triggers#patch-subscription + source: | + from sailpoint.v2025.api.triggers_api import TriggersApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.subscription import Subscription + from sailpoint.v2025.models.subscription_patch_request_inner import SubscriptionPatchRequestInner + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | ID of the Subscription to patch # str | ID of the Subscription to patch + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + subscription_patch_request_inner = '''[sailpoint.v2025.SubscriptionPatchRequestInner()]''' # List[SubscriptionPatchRequestInner] | + try: + # Patch a Subscription + new_subscription_patch_request_inner = SubscriptionPatchRequestInner.from_json(subscription_patch_request_inner) + results = TriggersApi(api_client).patch_subscription(id=id, x_sail_point_experimental=x_sail_point_experimental, subscription_patch_request_inner=new_subscription_patch_request_inner) + # Below is a request that includes all optional parameters + # results = TriggersApi(api_client).patch_subscription(id, x_sail_point_experimental, new_subscription_patch_request_inner) + print("The response of TriggersApi->patch_subscription:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling TriggersApi->patch_subscription: %s\n" % e) delete: operationId: deleteSubscription tags: @@ -74689,31 +97236,31 @@ paths: responses: '204': $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/204.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - sp:trigger-service-subscriptions:manage x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/triggers#delete-subscription + label: SDK_tools/sdk/powershell/v2025/methods/triggers#delete-subscription source: | $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -74721,14 +97268,35 @@ paths: # Delete a Subscription try { - Remove-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental + Remove-V2025Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Remove-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental + # Remove-V2025Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Subscription" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Subscription" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/triggers#delete-subscription + source: | + from sailpoint.v2025.api.triggers_api import TriggersApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Delete a Subscription + + TriggersApi(api_client).delete_subscription(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # TriggersApi(api_client).delete_subscription(id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling TriggersApi->delete_subscription: %s\n" % e) /trigger-subscriptions/validate-filter: post: operationId: testSubscriptionFilter @@ -74793,19 +97361,19 @@ paths: isPathExist: true '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - sp:trigger-service-subscriptions:manage @@ -74820,7 +97388,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/triggers#test-subscription-filter + label: SDK_tools/sdk/powershell/v2025/methods/triggers#test-subscription-filter source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $ValidateFilterInputDto = @" @@ -74836,14 +97404,44 @@ paths: try { $Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto - Test-V2024SubscriptionFilter -XSailPointExperimental $XSailPointExperimental -ValidateFilterInputDto $Result + Test-V2025SubscriptionFilter -XSailPointExperimental $XSailPointExperimental -ValidateFilterInputDto $Result # Below is a request that includes all optional parameters - # Test-V2024SubscriptionFilter -XSailPointExperimental $XSailPointExperimental -ValidateFilterInputDto $Result + # Test-V2025SubscriptionFilter -XSailPointExperimental $XSailPointExperimental -ValidateFilterInputDto $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024SubscriptionFilter" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025SubscriptionFilter" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/triggers#test-subscription-filter + source: | + from sailpoint.v2025.api.triggers_api import TriggersApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.validate_filter_input_dto import ValidateFilterInputDto + from sailpoint.v2025.models.validate_filter_output_dto import ValidateFilterOutputDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + validate_filter_input_dto = '''{ + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + } + }''' # ValidateFilterInputDto | + try: + # Validate a Subscription Filter + new_validate_filter_input_dto = ValidateFilterInputDto.from_json(validate_filter_input_dto) + results = TriggersApi(api_client).test_subscription_filter(x_sail_point_experimental=x_sail_point_experimental, validate_filter_input_dto=new_validate_filter_input_dto) + # Below is a request that includes all optional parameters + # results = TriggersApi(api_client).test_subscription_filter(x_sail_point_experimental, new_validate_filter_input_dto) + print("The response of TriggersApi->test_subscription_filter:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling TriggersApi->test_subscription_filter: %s\n" % e) /trigger-invocations/status: get: operationId: listTriggerInvocationStatus @@ -74855,12 +97453,12 @@ paths: Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - in: query name: filters required: false @@ -74972,7 +97570,7 @@ paths: properties: localizedError: $ref: '#/paths/~1identities~1invite/post/responses/202/content/application~1json/schema/properties/messages/items/properties/localizedText' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/LocalizedMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/LocalizedMessage.yaml output: type: object nullable: true @@ -74981,26 +97579,26 @@ paths: description: Trigger output that completed the invocation. Its schema is defined in the trigger definition. '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - sp:trigger-service-invocation-status:read - sp:trigger-service-invocation-status:manage x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/triggers#list-trigger-invocation-status + label: SDK_tools/sdk/powershell/v2025/methods/triggers#list-trigger-invocation-status source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $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) @@ -75012,14 +97610,42 @@ paths: # List Latest Invocation Statuses try { - Get-V2024TriggerInvocationStatus -XSailPointExperimental $XSailPointExperimental + Get-V2025TriggerInvocationStatus -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024TriggerInvocationStatus -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + # Get-V2025TriggerInvocationStatus -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TriggerInvocationStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TriggerInvocationStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/triggers#list-trigger-invocation-status + source: | + from sailpoint.v2025.api.triggers_api import TriggersApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.invocation_status import InvocationStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + filters = 'triggerId eq \"idn:access-request-dynamic-approver\"' # 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: **triggerId**: *eq* **subscriptionId**: *eq* (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: **triggerId**: *eq* **subscriptionId**: *eq* (optional) + sorters = 'created' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, subscriptionName, created, completed** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, subscriptionName, created, completed** (optional) + try: + # List Latest Invocation Statuses + + results = TriggersApi(api_client).list_trigger_invocation_status(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = TriggersApi(api_client).list_trigger_invocation_status(x_sail_point_experimental, limit, offset, count, filters, sorters) + print("The response of TriggersApi->list_trigger_invocation_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling TriggersApi->list_trigger_invocation_status: %s\n" % e) /trigger-invocations/{id}/complete: post: operationId: completeTriggerInvocation @@ -75074,25 +97700,25 @@ paths: responses: '204': $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/204.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/triggers#complete-trigger-invocation + label: SDK_tools/sdk/powershell/v2025/methods/triggers#complete-trigger-invocation source: | $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the invocation to complete. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -75110,14 +97736,43 @@ paths: try { $Result = ConvertFrom-JsonToCompleteInvocation -Json $CompleteInvocation - Complete-V2024TriggerInvocation -Id $Id -XSailPointExperimental $XSailPointExperimental -CompleteInvocation $Result + Complete-V2025TriggerInvocation -Id $Id -XSailPointExperimental $XSailPointExperimental -CompleteInvocation $Result # Below is a request that includes all optional parameters - # Complete-V2024TriggerInvocation -Id $Id -XSailPointExperimental $XSailPointExperimental -CompleteInvocation $Result + # Complete-V2025TriggerInvocation -Id $Id -XSailPointExperimental $XSailPointExperimental -CompleteInvocation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024TriggerInvocation" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2025TriggerInvocation" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/triggers#complete-trigger-invocation + source: | + from sailpoint.v2025.api.triggers_api import TriggersApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.complete_invocation import CompleteInvocation + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | The ID of the invocation to complete. # str | The ID of the invocation to complete. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + complete_invocation = '''{ + "output" : { + "approved" : false + }, + "secret" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "error" : "Access request is denied." + }''' # CompleteInvocation | + try: + # Complete Trigger Invocation + new_complete_invocation = CompleteInvocation.from_json(complete_invocation) + TriggersApi(api_client).complete_trigger_invocation(id=id, x_sail_point_experimental=x_sail_point_experimental, complete_invocation=new_complete_invocation) + # Below is a request that includes all optional parameters + # TriggersApi(api_client).complete_trigger_invocation(id, x_sail_point_experimental, new_complete_invocation) + except Exception as e: + print("Exception when calling TriggersApi->complete_trigger_invocation: %s\n" % e) /trigger-invocations/test: post: operationId: startTestTriggerInvocation @@ -75200,22 +97855,22 @@ paths: description: JSON map of invocation metadata. '204': $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/204.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - sp:trigger-service-invocation-status:manage @@ -75230,7 +97885,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/triggers#start-test-trigger-invocation + label: SDK_tools/sdk/powershell/v2025/methods/triggers#start-test-trigger-invocation source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $TestInvocation = @" @@ -75250,14 +97905,48 @@ paths: try { $Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation - Start-V2024TestTriggerInvocation -XSailPointExperimental $XSailPointExperimental -TestInvocation $Result + Start-V2025TestTriggerInvocation -XSailPointExperimental $XSailPointExperimental -TestInvocation $Result # Below is a request that includes all optional parameters - # Start-V2024TestTriggerInvocation -XSailPointExperimental $XSailPointExperimental -TestInvocation $Result + # Start-V2025TestTriggerInvocation -XSailPointExperimental $XSailPointExperimental -TestInvocation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024TestTriggerInvocation" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025TestTriggerInvocation" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/triggers#start-test-trigger-invocation + source: | + from sailpoint.v2025.api.triggers_api import TriggersApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.invocation import Invocation + from sailpoint.v2025.models.test_invocation import TestInvocation + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + test_invocation = '''{ + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + }, + "subscriptionIds" : [ "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" ], + "triggerId" : "idn:access-request-post-approval", + "contentJson" : { + "workflowId" : 1234 + } + }''' # TestInvocation | + try: + # Start a Test Invocation + new_test_invocation = TestInvocation.from_json(test_invocation) + results = TriggersApi(api_client).start_test_trigger_invocation(x_sail_point_experimental=x_sail_point_experimental, test_invocation=new_test_invocation) + # Below is a request that includes all optional parameters + # results = TriggersApi(api_client).start_test_trigger_invocation(x_sail_point_experimental, new_test_invocation) + print("The response of TriggersApi->start_test_trigger_invocation:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling TriggersApi->start_test_trigger_invocation: %s\n" % e) /ui-metadata/tenant: get: operationId: getTenantUiMetadata @@ -75295,22 +97984,22 @@ paths: example: Please provide your work email address... '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -75322,21 +98011,44 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/ui-metadata#get-tenant-ui-metadata + label: SDK_tools/sdk/powershell/v2025/methods/ui-metadata#get-tenant-ui-metadata source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Get a tenant UI metadata try { - Get-V2024TenantUiMetadata -XSailPointExperimental $XSailPointExperimental + Get-V2025TenantUiMetadata -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024TenantUiMetadata -XSailPointExperimental $XSailPointExperimental + # Get-V2025TenantUiMetadata -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TenantUiMetadata" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TenantUiMetadata" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/ui-metadata#get-tenant-ui-metadata + source: | + from sailpoint.v2025.api.ui_metadata_api import UIMetadataApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.tenant_ui_metadata_item_response import TenantUiMetadataItemResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get a tenant UI metadata + + results = UIMetadataApi(api_client).get_tenant_ui_metadata(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = UIMetadataApi(api_client).get_tenant_ui_metadata(x_sail_point_experimental) + print("The response of UIMetadataApi->get_tenant_ui_metadata:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling UIMetadataApi->get_tenant_ui_metadata: %s\n" % e) put: operationId: setTenantUiMetadata tags: @@ -75377,25 +98089,25 @@ paths: application/json: schema: $ref: '#/paths/~1ui-metadata~1tenant/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ui-metadata/TenantUiMetadataItemResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ui-metadata/TenantUiMetadataItemResponse.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -75407,7 +98119,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/ui-metadata#set-tenant-ui-metadata + label: SDK_tools/sdk/powershell/v2025/methods/ui-metadata#set-tenant-ui-metadata source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $TenantUiMetadataItemUpdateRequest = @" @@ -75422,14 +98134,43 @@ paths: try { $Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest - Set-V2024TenantUiMetadata -XSailPointExperimental $XSailPointExperimental -TenantUiMetadataItemUpdateRequest $Result + Set-V2025TenantUiMetadata -XSailPointExperimental $XSailPointExperimental -TenantUiMetadataItemUpdateRequest $Result # Below is a request that includes all optional parameters - # Set-V2024TenantUiMetadata -XSailPointExperimental $XSailPointExperimental -TenantUiMetadataItemUpdateRequest $Result + # Set-V2025TenantUiMetadata -XSailPointExperimental $XSailPointExperimental -TenantUiMetadataItemUpdateRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TenantUiMetadata" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025TenantUiMetadata" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/ui-metadata#set-tenant-ui-metadata + source: | + from sailpoint.v2025.api.ui_metadata_api import UIMetadataApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.tenant_ui_metadata_item_response import TenantUiMetadataItemResponse + from sailpoint.v2025.models.tenant_ui_metadata_item_update_request import TenantUiMetadataItemUpdateRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + tenant_ui_metadata_item_update_request = '''{ + "usernameEmptyText" : "Please provide your work email address...", + "usernameLabel" : "Email", + "iframeWhiteList" : "http://example.com http://example2.com" + }''' # TenantUiMetadataItemUpdateRequest | + try: + # Update tenant UI metadata + new_tenant_ui_metadata_item_update_request = TenantUiMetadataItemUpdateRequest.from_json(tenant_ui_metadata_item_update_request) + results = UIMetadataApi(api_client).set_tenant_ui_metadata(x_sail_point_experimental=x_sail_point_experimental, tenant_ui_metadata_item_update_request=new_tenant_ui_metadata_item_update_request) + # Below is a request that includes all optional parameters + # results = UIMetadataApi(api_client).set_tenant_ui_metadata(x_sail_point_experimental, new_tenant_ui_metadata_item_update_request) + print("The response of UIMetadataApi->set_tenant_ui_metadata:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling UIMetadataApi->set_tenant_ui_metadata: %s\n" % e) /verified-from-addresses: get: operationId: listFromAddresses @@ -75438,12 +98179,12 @@ paths: summary: List From Addresses description: Retrieve a list of sender email addresses and their verification statuses parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - in: query name: filters schema: @@ -75500,19 +98241,19 @@ paths: - FAILED '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/notifications#list-from-addresses + label: SDK_tools/sdk/powershell/v2025/methods/notifications#list-from-addresses source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $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) @@ -75524,14 +98265,42 @@ paths: # List From Addresses try { - Get-V2024FromAddresses -XSailPointExperimental $XSailPointExperimental + Get-V2025FromAddresses -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024FromAddresses -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + # Get-V2025FromAddresses -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FromAddresses" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025FromAddresses" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/notifications#list-from-addresses + source: | + from sailpoint.v2025.api.notifications_api import NotificationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.email_status_dto import EmailStatusDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + filters = 'email eq \"john.doe@company.com\"' # 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: **email**: *eq, ge, le, sw* (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: **email**: *eq, ge, le, sw* (optional) + sorters = 'email' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email** (optional) + try: + # List From Addresses + + results = NotificationsApi(api_client).list_from_addresses(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).list_from_addresses(x_sail_point_experimental, limit, offset, count, filters, sorters) + print("The response of NotificationsApi->list_from_addresses:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NotificationsApi->list_from_addresses: %s\n" % e) post: operationId: createVerifiedFromAddress tags: @@ -75544,7 +98313,7 @@ paths: application/json: schema: $ref: '#/paths/~1verified-from-addresses/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/EmailStatusDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/EmailStatusDto.yaml example: email: sender@example.com responses: @@ -75554,22 +98323,22 @@ paths: application/json: schema: $ref: '#/paths/~1verified-from-addresses/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/EmailStatusDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/EmailStatusDto.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -75581,7 +98350,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/notifications#create-verified-from-address + label: SDK_tools/sdk/powershell/v2025/methods/notifications#create-verified-from-address source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $EmailStatusDto = @" @@ -75597,14 +98366,43 @@ paths: try { $Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto - New-V2024VerifiedFromAddress -XSailPointExperimental $XSailPointExperimental -EmailStatusDto $Result + New-V2025VerifiedFromAddress -XSailPointExperimental $XSailPointExperimental -EmailStatusDto $Result # Below is a request that includes all optional parameters - # New-V2024VerifiedFromAddress -XSailPointExperimental $XSailPointExperimental -EmailStatusDto $Result + # New-V2025VerifiedFromAddress -XSailPointExperimental $XSailPointExperimental -EmailStatusDto $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024VerifiedFromAddress" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025VerifiedFromAddress" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/notifications#create-verified-from-address + source: | + from sailpoint.v2025.api.notifications_api import NotificationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.email_status_dto import EmailStatusDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + email_status_dto = '''{ + "isVerifiedByDomain" : false, + "verificationStatus" : "PENDING", + "id" : "id", + "email" : "sender@example.com" + }''' # EmailStatusDto | + try: + # Create Verified From Address + new_email_status_dto = EmailStatusDto.from_json(email_status_dto) + results = NotificationsApi(api_client).create_verified_from_address(x_sail_point_experimental=x_sail_point_experimental, email_status_dto=new_email_status_dto) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).create_verified_from_address(x_sail_point_experimental, new_email_status_dto) + print("The response of NotificationsApi->create_verified_from_address:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NotificationsApi->create_verified_from_address: %s\n" % e) /verified-from-addresses/{id}: delete: operationId: deleteVerifiedFromAddress @@ -75630,28 +98428,28 @@ paths: responses: '204': $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/204.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/notifications#delete-verified-from-address + label: SDK_tools/sdk/powershell/v2025/methods/notifications#delete-verified-from-address source: | $Id = "MyId" # String | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -75659,14 +98457,35 @@ paths: # Delete Verified From Address try { - Remove-V2024VerifiedFromAddress -Id $Id -XSailPointExperimental $XSailPointExperimental + Remove-V2025VerifiedFromAddress -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Remove-V2024VerifiedFromAddress -Id $Id -XSailPointExperimental $XSailPointExperimental + # Remove-V2025VerifiedFromAddress -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024VerifiedFromAddress" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025VerifiedFromAddress" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/notifications#delete-verified-from-address + source: | + from sailpoint.v2025.api.notifications_api import NotificationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = 'id_example' # str | # str | + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Delete Verified From Address + + NotificationsApi(api_client).delete_verified_from_address(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # NotificationsApi(api_client).delete_verified_from_address(id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling NotificationsApi->delete_verified_from_address: %s\n" % e) /verified-domains: get: security: @@ -75716,19 +98535,19 @@ paths: description: DKIM attributes for a domain or identity '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -75740,21 +98559,44 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/notifications#get-dkim-attributes + label: SDK_tools/sdk/powershell/v2025/methods/notifications#get-dkim-attributes source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Get DKIM Attributes try { - Get-V2024DkimAttributes -XSailPointExperimental $XSailPointExperimental + Get-V2025DkimAttributes -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024DkimAttributes -XSailPointExperimental $XSailPointExperimental + # Get-V2025DkimAttributes -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DkimAttributes" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DkimAttributes" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/notifications#get-dkim-attributes + source: | + from sailpoint.v2025.api.notifications_api import NotificationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.dkim_attributes import DkimAttributes + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get DKIM Attributes + + results = NotificationsApi(api_client).get_dkim_attributes(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).get_dkim_attributes(x_sail_point_experimental) + print("The response of NotificationsApi->get_dkim_attributes:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NotificationsApi->get_dkim_attributes: %s\n" % e) post: security: - userAuth: @@ -75811,13 +98653,13 @@ paths: description: Domain status DTO containing everything required to verify via DKIM '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '405': description: Method Not Allowed - indicates that the server knows the request method, but the target resource doesn't support this method. content: @@ -75837,10 +98679,10 @@ paths: example: e7eab60924f64aa284175b9fa3309599 '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -75852,7 +98694,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/notifications#create-domain-dkim + label: SDK_tools/sdk/powershell/v2025/methods/notifications#create-domain-dkim source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $DomainAddress = @" @@ -75865,14 +98707,41 @@ paths: try { $Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress - New-V2024DomainDkim -XSailPointExperimental $XSailPointExperimental -DomainAddress $Result + New-V2025DomainDkim -XSailPointExperimental $XSailPointExperimental -DomainAddress $Result # Below is a request that includes all optional parameters - # New-V2024DomainDkim -XSailPointExperimental $XSailPointExperimental -DomainAddress $Result + # New-V2025DomainDkim -XSailPointExperimental $XSailPointExperimental -DomainAddress $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024DomainDkim" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025DomainDkim" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/notifications#create-domain-dkim + source: | + from sailpoint.v2025.api.notifications_api import NotificationsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.domain_address import DomainAddress + from sailpoint.v2025.models.domain_status_dto import DomainStatusDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + domain_address = '''{ + "domain" : "sailpoint.com" + }''' # DomainAddress | + try: + # Verify domain address via DKIM + new_domain_address = DomainAddress.from_json(domain_address) + results = NotificationsApi(api_client).create_domain_dkim(x_sail_point_experimental=x_sail_point_experimental, domain_address=new_domain_address) + # Below is a request that includes all optional parameters + # results = NotificationsApi(api_client).create_domain_dkim(x_sail_point_experimental, new_domain_address) + print("The response of NotificationsApi->create_domain_dkim:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NotificationsApi->create_domain_dkim: %s\n" % e) /workgroups: get: operationId: listWorkgroups @@ -75882,11 +98751,11 @@ paths: description: This API returns list of Governance Groups parameters: - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit50.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml + - $ref: '#/paths/~1connector-rules/get/parameters/0' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit50.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - in: query name: filters schema: @@ -75934,23 +98803,8 @@ paths: properties: owner: allOf: - - type: object - description: Owner's identity. - properties: - type: - type: string - description: Owner's DTO type. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: Owner's identity ID. - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - description: Owner's name. - example: Support + - $ref: '#/components/schemas/ServiceDeskIntegrationDto/allOf/0/properties/ownerRef/allOf/0' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/OwnerDto.yaml - type: object properties: displayName: @@ -75999,25 +98853,25 @@ paths: example: '2022-01-06T19:51:13Z' '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:workgroup:read x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/governance-groups#list-workgroups + label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#list-workgroups source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $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) @@ -76029,14 +98883,42 @@ paths: # List Governance Groups try { - Get-V2024Workgroups -XSailPointExperimental $XSailPointExperimental + Get-V2025Workgroups -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024Workgroups -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters -Sorters $Sorters + # Get-V2025Workgroups -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workgroups" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Workgroups" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/governance-groups#list-workgroups + source: | + from sailpoint.v2025.api.governance_groups_api import GovernanceGroupsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workgroup_dto import WorkgroupDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + 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) + filters = 'name sw \"Test\"' # 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: **id**: *eq, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (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: **id**: *eq, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (optional) + sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, description** (optional) + try: + # List Governance Groups + + results = GovernanceGroupsApi(api_client).list_workgroups(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = GovernanceGroupsApi(api_client).list_workgroups(x_sail_point_experimental, offset, limit, count, filters, sorters) + print("The response of GovernanceGroupsApi->list_workgroups:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->list_workgroups: %s\n" % e) post: operationId: createWorkgroup security: @@ -76052,7 +98934,7 @@ paths: application/json: schema: $ref: '#/paths/~1workgroups/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/workgroups/WorkgroupDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/workgroups/WorkgroupDto.yaml responses: '200': description: Governance Group object created. @@ -76060,22 +98942,22 @@ paths: application/json: schema: $ref: '#/paths/~1workgroups/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/workgroups/WorkgroupDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/workgroups/WorkgroupDto.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml parameters: - name: X-SailPoint-Experimental in: header @@ -76087,7 +98969,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/governance-groups#create-workgroup + label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#create-workgroup source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $WorkgroupDto = @" @@ -76113,14 +98995,53 @@ paths: try { $Result = ConvertFrom-JsonToWorkgroupDto -Json $WorkgroupDto - New-V2024Workgroup -XSailPointExperimental $XSailPointExperimental -WorkgroupDto $Result + New-V2025Workgroup -XSailPointExperimental $XSailPointExperimental -WorkgroupDto $Result # Below is a request that includes all optional parameters - # New-V2024Workgroup -XSailPointExperimental $XSailPointExperimental -WorkgroupDto $Result + # New-V2025Workgroup -XSailPointExperimental $XSailPointExperimental -WorkgroupDto $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workgroup" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Workgroup" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/governance-groups#create-workgroup + source: | + from sailpoint.v2025.api.governance_groups_api import GovernanceGroupsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workgroup_dto import WorkgroupDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + workgroup_dto = '''{ + "owner" : { + "emailAddress" : "support@sailpoint.com", + "displayName" : "Support", + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "connectionCount" : 1641498673000, + "created" : "2022-01-06T19:51:13Z", + "memberCount" : 1641498673000, + "name" : "DB Access Governance Group", + "description" : "Description of the Governance Group", + "modified" : "2022-01-06T19:51:13Z", + "id" : "2c91808568c529c60168cca6f90c1313" + }''' # WorkgroupDto | + try: + # Create a new Governance Group. + new_workgroup_dto = WorkgroupDto.from_json(workgroup_dto) + results = GovernanceGroupsApi(api_client).create_workgroup(x_sail_point_experimental=x_sail_point_experimental, workgroup_dto=new_workgroup_dto) + # Below is a request that includes all optional parameters + # results = GovernanceGroupsApi(api_client).create_workgroup(x_sail_point_experimental, new_workgroup_dto) + print("The response of GovernanceGroupsApi->create_workgroup:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->create_workgroup: %s\n" % e) /workgroups/{id}: get: operationId: getWorkgroup @@ -76151,22 +99072,22 @@ paths: application/json: schema: $ref: '#/paths/~1workgroups/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/workgroups/WorkgroupDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/workgroups/WorkgroupDto.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:workgroup:read @@ -76176,7 +99097,7 @@ paths: - ORG_ADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/governance-groups#get-workgroup + label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#get-workgroup source: | $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -76184,14 +99105,38 @@ paths: # Get Governance Group by Id try { - Get-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2025Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental + # Get-V2025Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workgroup" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Workgroup" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/governance-groups#get-workgroup + source: | + from sailpoint.v2025.api.governance_groups_api import GovernanceGroupsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workgroup_dto import WorkgroupDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get Governance Group by Id + + results = GovernanceGroupsApi(api_client).get_workgroup(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = GovernanceGroupsApi(api_client).get_workgroup(id, x_sail_point_experimental) + print("The response of GovernanceGroupsApi->get_workgroup:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->get_workgroup: %s\n" % e) delete: operationId: deleteWorkgroup tags: @@ -76217,22 +99162,22 @@ paths: responses: '204': $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/204.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:workgroup:write @@ -76242,7 +99187,7 @@ paths: - ORG_ADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/governance-groups#delete-workgroup + label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#delete-workgroup source: | $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -76250,14 +99195,35 @@ paths: # Delete a Governance Group try { - Remove-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental + Remove-V2025Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Remove-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental + # Remove-V2025Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Workgroup" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Workgroup" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/governance-groups#delete-workgroup + source: | + from sailpoint.v2025.api.governance_groups_api import GovernanceGroupsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Delete a Governance Group + + GovernanceGroupsApi(api_client).delete_workgroup(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # GovernanceGroupsApi(api_client).delete_workgroup(id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->delete_workgroup: %s\n" % e) patch: operationId: patchWorkgroup tags: @@ -76291,7 +99257,7 @@ paths: type: array items: $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/JsonPatchOperation.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml examples: Replace Description: description: Replace description of a Governance Group. @@ -76306,22 +99272,22 @@ paths: application/json: schema: $ref: '#/paths/~1workgroups/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/workgroups/WorkgroupDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/workgroups/WorkgroupDto.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:workgroup:write @@ -76331,7 +99297,7 @@ paths: - ORG_ADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/governance-groups#patch-workgroup + label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#patch-workgroup source: | $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -76345,14 +99311,40 @@ paths: # Patch a Governance Group try { - Update-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental + Update-V2025Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Update-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + # Update-V2025Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workgroup" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Workgroup" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/governance-groups#patch-workgroup + source: | + from sailpoint.v2025.api.governance_groups_api import GovernanceGroupsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2025.models.workgroup_dto import WorkgroupDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch_operation = '''[{op=replace, path=/description, value=Governance Group new description.}]''' # List[JsonPatchOperation] | (optional) + try: + # Patch a Governance Group + + results = GovernanceGroupsApi(api_client).patch_workgroup(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = GovernanceGroupsApi(api_client).patch_workgroup(id, x_sail_point_experimental, new_json_patch_operation) + print("The response of GovernanceGroupsApi->patch_workgroup:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->patch_workgroup: %s\n" % e) /workgroups/bulk-delete: post: operationId: deleteWorkgroupsInBulk @@ -76439,19 +99431,19 @@ paths: description: Governance Group deleted successfully. '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:workgroup:write @@ -76466,7 +99458,7 @@ paths: required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/governance-groups#delete-workgroups-in-bulk + label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#delete-workgroups-in-bulk source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $WorkgroupBulkDeleteRequest = @" @@ -76479,14 +99471,41 @@ paths: try { $Result = ConvertFrom-JsonToWorkgroupBulkDeleteRequest -Json $WorkgroupBulkDeleteRequest - Remove-V2024WorkgroupsInBulk -XSailPointExperimental $XSailPointExperimental -WorkgroupBulkDeleteRequest $Result + Remove-V2025WorkgroupsInBulk -XSailPointExperimental $XSailPointExperimental -WorkgroupBulkDeleteRequest $Result # Below is a request that includes all optional parameters - # Remove-V2024WorkgroupsInBulk -XSailPointExperimental $XSailPointExperimental -WorkgroupBulkDeleteRequest $Result + # Remove-V2025WorkgroupsInBulk -XSailPointExperimental $XSailPointExperimental -WorkgroupBulkDeleteRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024WorkgroupsInBulk" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025WorkgroupsInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/governance-groups#delete-workgroups-in-bulk + source: | + from sailpoint.v2025.api.governance_groups_api import GovernanceGroupsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workgroup_bulk_delete_request import WorkgroupBulkDeleteRequest + from sailpoint.v2025.models.workgroup_delete_item import WorkgroupDeleteItem + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + workgroup_bulk_delete_request = '''{ + "ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ] + }''' # WorkgroupBulkDeleteRequest | + try: + # Delete Governance Group(s) + new_workgroup_bulk_delete_request = WorkgroupBulkDeleteRequest.from_json(workgroup_bulk_delete_request) + results = GovernanceGroupsApi(api_client).delete_workgroups_in_bulk(x_sail_point_experimental=x_sail_point_experimental, workgroup_bulk_delete_request=new_workgroup_bulk_delete_request) + # Below is a request that includes all optional parameters + # results = GovernanceGroupsApi(api_client).delete_workgroups_in_bulk(x_sail_point_experimental, new_workgroup_bulk_delete_request) + print("The response of GovernanceGroupsApi->delete_workgroups_in_bulk:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->delete_workgroups_in_bulk: %s\n" % e) /workgroups/{workgroupId}/connections: get: operationId: listConnections @@ -76503,11 +99522,11 @@ paths: type: string example: 2c91808a7813090a017814121919ecca - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit50.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml + - $ref: '#/paths/~1connector-rules/get/parameters/0' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit50.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - in: query name: sorters schema: @@ -76538,29 +99557,34 @@ paths: type: object properties: object: - type: object - properties: - type: - type: string - enum: - - ACCESS_PROFILE - - ROLE - - SOD_POLICY - - SOURCE - description: An enumeration of the types of Objects associated with a Governance Group. Supported object types are ACCESS_PROFILE, ROLE, SOD_POLICY and SOURCE. - example: ACCESS_PROFILE - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable name of Connected object - example: Employee-database-read-write - description: - type: string - description: Description of the Connected object. - example: Collection of entitlements to read/write the employee database. + allOf: + - type: object + properties: + type: + allOf: + - type: string + enum: + - ACCESS_PROFILE + - ROLE + - SOD_POLICY + - SOURCE + description: An enumeration of the types of Objects associated with a Governance Group. Supported object types are ACCESS_PROFILE, ROLE, SOD_POLICY and SOURCE. + example: ACCESS_PROFILE + - description: Connection Object type + id: + type: string + description: ID of the object to which this reference applies + example: 2c91808568c529c60168cca6f90c1313 + name: + type: string + description: Human-readable name of Connected object + example: Employee-database-read-write + description: + type: string + nullable: true + description: Description of the Connected object. + example: Collection of entitlements to read/write the employee database. + - description: Connected object to Governance Group connectionType: description: Connection Type. type: string @@ -76571,25 +99595,25 @@ paths: example: AccessRequestReviewer '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:workgroup:read x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/governance-groups#list-connections + label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#list-connections source: | $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -76601,14 +99625,42 @@ paths: # List connections for Governance Group try { - Get-V2024Connections -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental + Get-V2025Connections -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024Connections -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters + # Get-V2025Connections -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Connections" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Connections" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/governance-groups#list-connections + source: | + from sailpoint.v2025.api.governance_groups_api import GovernanceGroupsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.workgroup_connection_dto import WorkgroupConnectionDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + 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) + sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + try: + # List connections for Governance Group + + results = GovernanceGroupsApi(api_client).list_connections(workgroup_id=workgroup_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = GovernanceGroupsApi(api_client).list_connections(workgroup_id, x_sail_point_experimental, offset, limit, count, sorters) + print("The response of GovernanceGroupsApi->list_connections:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->list_connections: %s\n" % e) /workgroups/{workgroupId}/members: get: operationId: listWorkgroupMembers @@ -76625,11 +99677,11 @@ paths: type: string example: 2c91808a7813090a017814121919ecca - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit50.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml + - $ref: '#/paths/~1connector-rules/get/parameters/0' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit50.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - in: query name: sorters schema: @@ -76680,25 +99732,25 @@ paths: example: michael.michaels@sailpoint.com '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:workgroup:read x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/governance-groups#list-workgroup-members + label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#list-workgroup-members source: | $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -76710,14 +99762,42 @@ paths: # List Governance Group Members try { - Get-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental + Get-V2025WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters + # Get-V2025WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkgroupMembers" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkgroupMembers" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/governance-groups#list-workgroup-members + source: | + from sailpoint.v2025.api.governance_groups_api import GovernanceGroupsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.list_workgroup_members200_response_inner import ListWorkgroupMembers200ResponseInner + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + 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) + sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + try: + # List Governance Group Members + + results = GovernanceGroupsApi(api_client).list_workgroup_members(workgroup_id=workgroup_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = GovernanceGroupsApi(api_client).list_workgroup_members(workgroup_id, x_sail_point_experimental, offset, limit, count, sorters) + print("The response of GovernanceGroupsApi->list_workgroup_members:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->list_workgroup_members: %s\n" % e) /workgroups/{workgroupId}/members/bulk-add: post: operationId: updateWorkgroupMembers @@ -76824,22 +99904,22 @@ paths: description: Identity added to Governance Group members list. '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/governance-groups#update-workgroup-members + label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#update-workgroup-members source: | $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -76850,14 +99930,40 @@ paths: try { $Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity - Update-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result + Update-V2025WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result # Below is a request that includes all optional parameters - # Update-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result + # Update-V2025WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024WorkgroupMembers" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025WorkgroupMembers" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/governance-groups#update-workgroup-members + source: | + from sailpoint.v2025.api.governance_groups_api import GovernanceGroupsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_preview_response_identity import IdentityPreviewResponseIdentity + from sailpoint.v2025.models.workgroup_member_add_item import WorkgroupMemberAddItem + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + identity_preview_response_identity = '''[sailpoint.v2025.IdentityPreviewResponseIdentity()]''' # List[IdentityPreviewResponseIdentity] | List of identities to be added to a Governance Group members list. + try: + # Add members to Governance Group + new_identity_preview_response_identity = IdentityPreviewResponseIdentity.from_json(identity_preview_response_identity) + results = GovernanceGroupsApi(api_client).update_workgroup_members(workgroup_id=workgroup_id, x_sail_point_experimental=x_sail_point_experimental, identity_preview_response_identity=new_identity_preview_response_identity) + # Below is a request that includes all optional parameters + # results = GovernanceGroupsApi(api_client).update_workgroup_members(workgroup_id, x_sail_point_experimental, new_identity_preview_response_identity) + print("The response of GovernanceGroupsApi->update_workgroup_members:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->update_workgroup_members: %s\n" % e) /workgroups/{workgroupId}/members/bulk-delete: post: operationId: deleteWorkgroupMembers @@ -76899,7 +100005,7 @@ paths: application/json: schema: $ref: '#/paths/~1workgroups~1%7BworkgroupId%7D~1members~1bulk-add/post/requestBody/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/workgroups/BulkWorkgroupMembersRequest.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/workgroups/BulkWorkgroupMembersRequest.yaml responses: '207': description: List of deleted and not deleted identities from Governance Group members list. @@ -76943,22 +100049,22 @@ paths: description: Identity deleted from Governance Group members list. '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/governance-groups#delete-workgroup-members + label: SDK_tools/sdk/powershell/v2025/methods/governance-groups#delete-workgroup-members source: | $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -76969,14 +100075,40 @@ paths: try { $Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity - Remove-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result + Remove-V2025WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result # Below is a request that includes all optional parameters - # Remove-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result + # Remove-V2025WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024WorkgroupMembers" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025WorkgroupMembers" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/governance-groups#delete-workgroup-members + source: | + from sailpoint.v2025.api.governance_groups_api import GovernanceGroupsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_preview_response_identity import IdentityPreviewResponseIdentity + from sailpoint.v2025.models.workgroup_member_delete_item import WorkgroupMemberDeleteItem + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + identity_preview_response_identity = '''[sailpoint.v2025.IdentityPreviewResponseIdentity()]''' # List[IdentityPreviewResponseIdentity] | List of identities to be removed from a Governance Group members list. + try: + # Remove members from Governance Group + new_identity_preview_response_identity = IdentityPreviewResponseIdentity.from_json(identity_preview_response_identity) + results = GovernanceGroupsApi(api_client).delete_workgroup_members(workgroup_id=workgroup_id, x_sail_point_experimental=x_sail_point_experimental, identity_preview_response_identity=new_identity_preview_response_identity) + # Below is a request that includes all optional parameters + # results = GovernanceGroupsApi(api_client).delete_workgroup_members(workgroup_id, x_sail_point_experimental, new_identity_preview_response_identity) + print("The response of GovernanceGroupsApi->delete_workgroup_members:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GovernanceGroupsApi->delete_workgroup_members: %s\n" % e) /form-definitions: get: tags: @@ -77050,14 +100182,6 @@ paths: example: name required: false x-go-name: Sorters - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true responses: '200': description: Returns a list of form definitions by tenant @@ -77074,7 +100198,7 @@ paths: description: List of FormDefinitionResponse items. items: $ref: '#/paths/~1form-definitions/post/responses/201/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/FormDefinitionResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormDefinitionResponse.yaml type: array type: object '400': @@ -77131,7 +100255,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -77154,7 +100278,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -77180,7 +100304,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages trackingId: description: TrackingID is the request tracking unique identifier @@ -77202,7 +100326,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -77214,11 +100338,12 @@ paths: security: - userAuth: - sp:forms:manage + x-sailpoint-userLevels: + - ORG_ADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#search-form-definitions-by-tenant + label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#search-form-definitions-by-tenant source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Offset = 250 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) $Filters = "name sw "my form"" # 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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) @@ -77227,14 +100352,39 @@ paths: # Export form definitions by tenant. try { - Search-V2024FormDefinitionsByTenant -XSailPointExperimental $XSailPointExperimental + Search-V2025FormDefinitionsByTenant # Below is a request that includes all optional parameters - # Search-V2024FormDefinitionsByTenant -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters + # Search-V2025FormDefinitionsByTenant -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormDefinitionsByTenant" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025FormDefinitionsByTenant" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/custom-forms#search-form-definitions-by-tenant + source: | + from sailpoint.v2025.api.custom_forms_api import CustomFormsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.list_form_definitions_by_tenant_response import ListFormDefinitionsByTenantResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + offset = 0 # int | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) # int | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + limit = 250 # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + filters = 'name sw \"my form\"' # 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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to 'name') # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to 'name') + try: + # Export form definitions by tenant. + + results = CustomFormsApi(api_client).search_form_definitions_by_tenant() + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).search_form_definitions_by_tenant(offset, limit, filters, sorters) + print("The response of CustomFormsApi->search_form_definitions_by_tenant:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CustomFormsApi->search_form_definitions_by_tenant: %s\n" % e) post: tags: - Custom Forms @@ -77544,6 +100694,7 @@ paths: STRING FormDefinitionInputTypeString enum: - STRING + - ARRAY example: STRING type: string x-go-enum-desc: STRING FormDefinitionInputTypeString @@ -77635,6 +100786,27 @@ paths: owner: type: IDENTITY id: 00000000-0000-0000-0000-000000000000 + formElements: + - id: '000000000000' + elementType: SECTION + config: + alignment: LEFT + description: elementType must be 'SECTION' for the root formElements, child formElements must be within the 'config' attribute + label: Section + labelStyle: h2 + showLabel: true + formElements: + - id: '0000000000000' + key: textField + elementType: TEXT + config: + default: '' + description: '' + helpText: form element type text + label: Text Field + placeholder: '' + required: false + validations: [] required: false responses: '201': @@ -77660,33 +100832,33 @@ paths: x-go-name: Description owner: $ref: '#/paths/~1form-definitions/post/requestBody/content/application~1json/schema/properties/owner' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/FormOwner.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormOwner.yaml usedBy: description: List of objects using the form definition. Whenever a system uses a form, the API reaches out to the form service to record that the system is currently using it. items: $ref: '#/paths/~1form-definitions/post/requestBody/content/application~1json/schema/properties/usedBy/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/FormUsedBy.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormUsedBy.yaml type: array x-go-name: UsedBy formInput: description: List of form inputs required to create a form-instance object. items: $ref: '#/paths/~1form-definitions/post/requestBody/content/application~1json/schema/properties/formInput/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/FormDefinitionInput.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormDefinitionInput.yaml type: array x-go-name: FormInput formElements: description: List of nested form elements. items: $ref: '#/paths/~1form-definitions/post/requestBody/content/application~1json/schema/properties/formElements/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/FormElement.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormElement.yaml type: array x-go-name: FormElements formConditions: description: Conditional logic that can dynamically modify the form as the recipient is interacting with it. items: $ref: '#/paths/~1form-definitions/post/requestBody/content/application~1json/schema/properties/formConditions/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/FormCondition.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormCondition.yaml type: array x-go-name: FormConditions created: @@ -77717,7 +100889,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -77740,7 +100912,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -77763,7 +100935,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -77778,7 +100950,7 @@ paths: application/json: schema: $ref: '#/paths/~1form-definitions/get/responses/429/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/Error.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/Error.yaml '500': description: An internal server error occurred content: @@ -77793,7 +100965,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -77805,21 +100977,13 @@ paths: security: - userAuth: - sp:forms:manage + x-sailpoint-userLevels: + - ORG_ADMIN x-codegen-request-body-name: Body - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#create-form-definition + label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#create-form-definition source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Body = @" { "owner" : { @@ -77937,14 +101101,147 @@ paths: # Creates a form definition. try { - New-V2024FormDefinition -XSailPointExperimental $XSailPointExperimental + New-V2025FormDefinition # Below is a request that includes all optional parameters - # New-V2024FormDefinition -XSailPointExperimental $XSailPointExperimental -Body $Result + # New-V2025FormDefinition -Body $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinition" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025FormDefinition" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/custom-forms#create-form-definition + source: | + from sailpoint.v2025.api.custom_forms_api import CustomFormsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.create_form_definition_request import CreateFormDefinitionRequest + from sailpoint.v2025.models.form_definition_response import FormDefinitionResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + body = '''{ + "owner" : { + "name" : "Grant Smith", + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "formConditions" : [ { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + }, { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + } ], + "formInput" : [ { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + }, { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + } ], + "name" : "My form", + "description" : "My form description", + "usedBy" : [ { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + }, { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + } ], + "formElements" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + } ] + }''' # CreateFormDefinitionRequest | Body is the request payload to create form definition request (optional) + try: + # Creates a form definition. + + results = CustomFormsApi(api_client).create_form_definition() + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).create_form_definition(new_body) + print("The response of CustomFormsApi->create_form_definition:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_definition: %s\n" % e) /form-definitions/{formDefinitionID}: get: tags: @@ -77963,14 +101260,6 @@ paths: x-go-name: FormDefinitionID example: 00000000-0000-0000-0000-000000000000 x-go-name: FormDefinitionID - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true responses: '200': description: Returns a form definition @@ -77978,7 +101267,7 @@ paths: application/json: schema: $ref: '#/paths/~1form-definitions/post/responses/201/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/FormDefinitionResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormDefinitionResponse.yaml '400': description: An error with the request occurred content: @@ -77993,7 +101282,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -78016,7 +101305,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -78039,7 +101328,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -78062,7 +101351,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -78077,7 +101366,7 @@ paths: application/json: schema: $ref: '#/paths/~1form-definitions/get/responses/429/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/Error.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/Error.yaml '500': description: An internal server error occurred content: @@ -78092,7 +101381,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -78106,22 +101395,43 @@ paths: - sp:forms:manage x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#get-form-definition-by-key + label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#get-form-definition-by-key source: | $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Return a form definition. try { - Get-V2024FormDefinitionByKey -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental + Get-V2025FormDefinitionByKey -FormDefinitionID $FormDefinitionID # Below is a request that includes all optional parameters - # Get-V2024FormDefinitionByKey -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental + # Get-V2025FormDefinitionByKey -FormDefinitionID $FormDefinitionID } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormDefinitionByKey" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025FormDefinitionByKey" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/custom-forms#get-form-definition-by-key + source: | + from sailpoint.v2025.api.custom_forms_api import CustomFormsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.form_definition_response import FormDefinitionResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID + try: + # Return a form definition. + + results = CustomFormsApi(api_client).get_form_definition_by_key(form_definition_id=form_definition_id) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).get_form_definition_by_key(form_definition_id) + print("The response of CustomFormsApi->get_form_definition_by_key:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CustomFormsApi->get_form_definition_by_key: %s\n" % e) delete: tags: - Custom Forms @@ -78139,14 +101449,6 @@ paths: x-go-name: FormDefinitionID example: 00000000-0000-0000-0000-000000000000 x-go-name: FormDefinitionID - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true responses: '204': description: Returns an empty body @@ -78170,7 +101472,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -78193,7 +101495,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -78216,7 +101518,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -78239,7 +101541,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -78254,7 +101556,7 @@ paths: application/json: schema: $ref: '#/paths/~1form-definitions/get/responses/429/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/Error.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/Error.yaml '500': description: An internal server error occurred content: @@ -78269,7 +101571,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -78283,22 +101585,42 @@ paths: - sp:forms:manage x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#delete-form-definition + label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#delete-form-definition source: | $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Deletes a form definition. try { - Remove-V2024FormDefinition -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental + Remove-V2025FormDefinition -FormDefinitionID $FormDefinitionID # Below is a request that includes all optional parameters - # Remove-V2024FormDefinition -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental + # Remove-V2025FormDefinition -FormDefinitionID $FormDefinitionID } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024FormDefinition" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025FormDefinition" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/custom-forms#delete-form-definition + source: | + from sailpoint.v2025.api.custom_forms_api import CustomFormsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID + try: + # Deletes a form definition. + + results = CustomFormsApi(api_client).delete_form_definition(form_definition_id=form_definition_id) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).delete_form_definition(form_definition_id) + print("The response of CustomFormsApi->delete_form_definition:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CustomFormsApi->delete_form_definition: %s\n" % e) patch: tags: - Custom Forms @@ -78316,14 +101638,6 @@ paths: x-go-name: FormDefinitionID example: 00000000-0000-0000-0000-000000000000 x-go-name: FormDefinitionID - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true requestBody: description: 'Body is the request payload to patch a form definition, check: https://jsonpatch.com' content: @@ -78356,7 +101670,7 @@ paths: application/json: schema: $ref: '#/paths/~1form-definitions/post/responses/201/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/FormDefinitionResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormDefinitionResponse.yaml '400': description: An error with the request occurred content: @@ -78371,7 +101685,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -78394,7 +101708,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -78417,7 +101731,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -78440,7 +101754,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -78455,7 +101769,7 @@ paths: application/json: schema: $ref: '#/paths/~1form-definitions/get/responses/429/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/Error.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/Error.yaml '500': description: An internal server error occurred content: @@ -78470,7 +101784,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -78485,10 +101799,9 @@ paths: x-codegen-request-body-name: Body x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#patch-form-definition + label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#patch-form-definition source: | $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Body = @{ key_example = } # Map[] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional) $Body = @"[{op=replace, path=/description, value=test-description}]"@ @@ -78496,14 +101809,37 @@ paths: # Patch a form definition. try { - Update-V2024FormDefinition -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental + Update-V2025FormDefinition -FormDefinitionID $FormDefinitionID # Below is a request that includes all optional parameters - # Update-V2024FormDefinition -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental -Body $Result + # Update-V2025FormDefinition -FormDefinitionID $FormDefinitionID -Body $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024FormDefinition" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025FormDefinition" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/custom-forms#patch-form-definition + source: | + from sailpoint.v2025.api.custom_forms_api import CustomFormsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.form_definition_response import FormDefinitionResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID + body = '''[{op=replace, path=/description, value=test-description}]''' # List[Dict[str, object]] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional) + try: + # Patch a form definition. + + results = CustomFormsApi(api_client).patch_form_definition(form_definition_id=form_definition_id) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).patch_form_definition(form_definition_id, new_body) + print("The response of CustomFormsApi->patch_form_definition:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CustomFormsApi->patch_form_definition: %s\n" % e) /form-definitions/{formDefinitionID}/data-source: post: tags: @@ -78565,14 +101901,6 @@ paths: example: ac required: false x-go-name: Query - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true requestBody: description: Body is the request payload to create a form definition dynamic schema content: @@ -78715,7 +102043,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -78738,7 +102066,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -78761,7 +102089,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -78784,7 +102112,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -78799,7 +102127,7 @@ paths: application/json: schema: $ref: '#/paths/~1form-definitions/get/responses/429/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/Error.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/Error.yaml '500': description: An internal server error occurred content: @@ -78814,7 +102142,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -78828,10 +102156,9 @@ paths: - sp:forms:manage x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#show-preview-data-source + label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#show-preview-data-source source: | $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Limit = 10 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) $Filters = "value eq "ID01"" # 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` (optional) $Query = "ac" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional) @@ -78852,14 +102179,51 @@ paths: # Preview form definition data source. try { - Show-V2024PreviewDataSource -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental + Show-V2025PreviewDataSource -FormDefinitionID $FormDefinitionID # Below is a request that includes all optional parameters - # Show-V2024PreviewDataSource -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Filters $Filters -Query $Query -FormElementPreviewRequest $Result + # Show-V2025PreviewDataSource -FormDefinitionID $FormDefinitionID -Limit $Limit -Filters $Filters -Query $Query -FormElementPreviewRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-V2024PreviewDataSource" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-V2025PreviewDataSource" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/custom-forms#show-preview-data-source + source: | + from sailpoint.v2025.api.custom_forms_api import CustomFormsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.form_element_preview_request import FormElementPreviewRequest + from sailpoint.v2025.models.preview_data_source_response import PreviewDataSourceResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID + limit = 10 # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) + filters = 'value eq \"ID01\"' # 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (optional) + query = 'ac' # str | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) # str | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) + form_element_preview_request = '''{ + "dataSource" : { + "config" : { + "indices" : [ "identities" ], + "query" : "*", + "aggregationBucketField" : "attributes.cloudStatus.exact", + "objectType" : "IDENTITY" + }, + "dataSourceType" : "STATIC" + } + }''' # FormElementPreviewRequest | Body is the request payload to create a form definition dynamic schema (optional) + try: + # Preview form definition data source. + + results = CustomFormsApi(api_client).show_preview_data_source(form_definition_id=form_definition_id) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).show_preview_data_source(form_definition_id, limit, filters, query, new_form_element_preview_request) + print("The response of CustomFormsApi->show_preview_data_source:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CustomFormsApi->show_preview_data_source: %s\n" % e) /form-definitions/export: get: tags: @@ -78879,6 +102243,7 @@ paths: type: integer format: int64 default: 0 + minimum: 0 x-go-name: Offset example: 0 required: false @@ -78893,8 +102258,8 @@ paths: schema: type: integer format: int64 - maxLength: 250 - minLength: 0 + minimum: 0 + maximum: 250 default: 250 x-go-name: Limit example: 250 @@ -78933,14 +102298,6 @@ paths: example: name required: false x-go-name: Sorters - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true responses: '200': description: Returns a list of form definition objects by tenant used by SP-Config @@ -78953,13 +102310,32 @@ paths: properties: object: $ref: '#/paths/~1form-definitions/post/responses/201/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/FormDefinitionResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormDefinitionResponse.yaml self: - type: string + type: object + properties: + object: + type: object + description: Self block for imported/exported object. + properties: + type: + type: string + description: Imported/exported object's DTO type. + enum: + - FORM_DEFINITION + example: FORM_DEFINITION + id: + type: string + description: Imported/exported object's ID. + example: 2c9180835d191a86015d28455b4b232a + name: + type: string + description: Imported/exported object's display name. + example: Temporary User Level Permissions - Requester x-go-name: Self version: type: integer - format: int8 + format: int32 x-go-name: Version '400': description: An error with the request occurred @@ -78975,7 +102351,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -78998,7 +102374,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -79021,7 +102397,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -79036,7 +102412,7 @@ paths: application/json: schema: $ref: '#/paths/~1form-definitions/get/responses/429/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/Error.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/Error.yaml '500': description: An internal server error occurred content: @@ -79051,7 +102427,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -79063,11 +102439,12 @@ paths: security: - userAuth: - sp:forms:manage + x-sailpoint-userLevels: + - ORG_ADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#export-form-definitions-by-tenant + label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#export-form-definitions-by-tenant source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Offset = 0 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) $Filters = "name sw "my form"" # 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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) @@ -79076,14 +102453,39 @@ paths: # List form definitions by tenant. try { - Export-V2024FormDefinitionsByTenant -XSailPointExperimental $XSailPointExperimental + Export-V2025FormDefinitionsByTenant # Below is a request that includes all optional parameters - # Export-V2024FormDefinitionsByTenant -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters + # Export-V2025FormDefinitionsByTenant -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024FormDefinitionsByTenant" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025FormDefinitionsByTenant" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/custom-forms#export-form-definitions-by-tenant + source: | + from sailpoint.v2025.api.custom_forms_api import CustomFormsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.export_form_definitions_by_tenant200_response_inner import ExportFormDefinitionsByTenant200ResponseInner + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + offset = 0 # int | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) # int | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + limit = 250 # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + filters = 'name sw \"my form\"' # 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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (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: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to 'name') # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to 'name') + try: + # List form definitions by tenant. + + results = CustomFormsApi(api_client).export_form_definitions_by_tenant() + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).export_form_definitions_by_tenant(offset, limit, filters, sorters) + print("The response of CustomFormsApi->export_form_definitions_by_tenant:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CustomFormsApi->export_form_definitions_by_tenant: %s\n" % e) /form-definitions/forms-action-dynamic-schema: post: tags: @@ -79183,7 +102585,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -79206,7 +102608,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -79229,7 +102631,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -79252,7 +102654,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -79267,7 +102669,7 @@ paths: application/json: schema: $ref: '#/paths/~1form-definitions/get/responses/429/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/Error.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/Error.yaml '500': description: An internal server error occurred content: @@ -79282,7 +102684,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -79295,20 +102697,10 @@ paths: - userAuth: - sp:forms:manage x-codegen-request-body-name: Body - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#create-form-definition-dynamic-schema + label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#create-form-definition-dynamic-schema source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Body = @" { "description" : "A description", @@ -79324,14 +102716,45 @@ paths: # Generate JSON Schema dynamically. try { - New-V2024FormDefinitionDynamicSchema -XSailPointExperimental $XSailPointExperimental + New-V2025FormDefinitionDynamicSchema # Below is a request that includes all optional parameters - # New-V2024FormDefinitionDynamicSchema -XSailPointExperimental $XSailPointExperimental -Body $Result + # New-V2025FormDefinitionDynamicSchema -Body $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinitionDynamicSchema" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025FormDefinitionDynamicSchema" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/custom-forms#create-form-definition-dynamic-schema + source: | + from sailpoint.v2025.api.custom_forms_api import CustomFormsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.form_definition_dynamic_schema_request import FormDefinitionDynamicSchemaRequest + from sailpoint.v2025.models.form_definition_dynamic_schema_response import FormDefinitionDynamicSchemaResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + body = '''{ + "description" : "A description", + "attributes" : { + "formDefinitionId" : "00000000-0000-0000-0000-000000000000" + }, + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "action", + "versionNumber" : 1 + }''' # FormDefinitionDynamicSchemaRequest | Body is the request payload to create a form definition dynamic schema (optional) + try: + # Generate JSON Schema dynamically. + + results = CustomFormsApi(api_client).create_form_definition_dynamic_schema() + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).create_form_definition_dynamic_schema(new_body) + print("The response of CustomFormsApi->create_form_definition_dynamic_schema:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_definition_dynamic_schema: %s\n" % e) /form-definitions/import: post: tags: @@ -79349,13 +102772,13 @@ paths: properties: object: $ref: '#/paths/~1form-definitions/post/responses/201/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/FormDefinitionResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormDefinitionResponse.yaml self: type: string x-go-name: Self version: type: integer - format: int8 + format: int32 x-go-name: Version example: - version: 1 @@ -79442,13 +102865,13 @@ paths: properties: object: $ref: '#/paths/~1form-definitions/post/responses/201/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/FormDefinitionResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormDefinitionResponse.yaml self: type: string x-go-name: Self version: type: integer - format: int8 + format: int32 x-go-name: Version x-go-name: ImportedObjects infos: @@ -79499,7 +102922,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -79522,7 +102945,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -79545,7 +102968,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -79560,7 +102983,7 @@ paths: application/json: schema: $ref: '#/paths/~1form-definitions/get/responses/429/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/Error.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/Error.yaml '500': description: An internal server error occurred content: @@ -79575,7 +102998,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -79588,20 +103011,10 @@ paths: - userAuth: - sp:forms:manage x-codegen-request-body-name: Body - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#import-form-definitions + label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#import-form-definitions source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -79614,14 +103027,37 @@ paths: # Import form definitions from export. try { - Import-V2024FormDefinitions -XSailPointExperimental $XSailPointExperimental + Import-V2025FormDefinitions # Below is a request that includes all optional parameters - # Import-V2024FormDefinitions -XSailPointExperimental $XSailPointExperimental -Body $Result + # Import-V2025FormDefinitions -Body $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024FormDefinitions" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025FormDefinitions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/custom-forms#import-form-definitions + source: | + from sailpoint.v2025.api.custom_forms_api import CustomFormsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.import_form_definitions202_response import ImportFormDefinitions202Response + from sailpoint.v2025.models.import_form_definitions_request_inner import ImportFormDefinitionsRequestInner + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + body = '''[{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}]''' # List[ImportFormDefinitionsRequestInner] | Body is the request payload to import form definitions (optional) + try: + # Import form definitions from export. + + results = CustomFormsApi(api_client).import_form_definitions() + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).import_form_definitions(new_body) + print("The response of CustomFormsApi->import_form_definitions:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CustomFormsApi->import_form_definitions: %s\n" % e) /form-definitions/{formDefinitionID}/upload: post: tags: @@ -79643,14 +103079,6 @@ paths: type: string x-go-name: FormDefinitionID x-go-name: FormDefinitionID - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true requestBody: content: multipart/form-data: @@ -79706,7 +103134,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -79729,7 +103157,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -79752,7 +103180,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -79775,7 +103203,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -79798,7 +103226,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -79821,7 +103249,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -79836,7 +103264,7 @@ paths: application/json: schema: $ref: '#/paths/~1form-definitions/get/responses/429/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/Error.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/Error.yaml '500': description: An internal server error occurred content: @@ -79851,7 +103279,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -79874,7 +103302,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -79889,23 +103317,45 @@ paths: x-codegen-request-body-name: Body x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#create-form-definition-file-request + label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#create-form-definition-file-request source: | $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID String specifying FormDefinitionID - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $File = # System.IO.FileInfo | File specifying the multipart # Upload new form definition file. try { - New-V2024FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental -File $File + New-V2025FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -File $File # Below is a request that includes all optional parameters - # New-V2024FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental -File $File + # New-V2025FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -File $File } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinitionFileRequest" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025FormDefinitionFileRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/custom-forms#create-form-definition-file-request + source: | + from sailpoint.v2025.api.custom_forms_api import CustomFormsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.form_definition_file_upload_response import FormDefinitionFileUploadResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + form_definition_id = '00000000-0000-0000-0000-000000000000' # str | FormDefinitionID String specifying FormDefinitionID # str | FormDefinitionID String specifying FormDefinitionID + file = None # bytearray | File specifying the multipart # bytearray | File specifying the multipart + try: + # Upload new form definition file. + + results = CustomFormsApi(api_client).create_form_definition_file_request(form_definition_id=form_definition_id, file=file) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).create_form_definition_file_request(form_definition_id, file) + print("The response of CustomFormsApi->create_form_definition_file_request:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_definition_file_request: %s\n" % e) /form-definitions/{formDefinitionID}/file/{fileID}: get: tags: @@ -79939,14 +103389,6 @@ paths: type: string x-go-name: FileID x-go-name: FileID - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true responses: '200': description: Returns a file that is referred to by fileID and associated with the formDefinitionID @@ -79981,7 +103423,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -80001,7 +103443,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -80021,7 +103463,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -80041,7 +103483,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -80064,7 +103506,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -80084,7 +103526,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -80104,7 +103546,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -80124,7 +103566,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -80147,7 +103589,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -80167,7 +103609,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -80187,7 +103629,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -80207,7 +103649,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -80230,7 +103672,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -80250,7 +103692,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -80270,7 +103712,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -80290,7 +103732,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -80305,7 +103747,7 @@ paths: application/json: schema: $ref: '#/paths/~1form-definitions/get/responses/429/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/Error.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/Error.yaml '500': description: An internal server error occurred content: @@ -80320,7 +103762,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -80340,7 +103782,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -80360,7 +103802,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -80380,7 +103822,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -80403,7 +103845,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -80423,7 +103865,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -80443,7 +103885,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -80463,7 +103905,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -80478,23 +103920,44 @@ paths: x-codegen-request-body-name: Body x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#get-file-from-s3 + label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#get-file-from-s3 source: | $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID Form definition ID $FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Download definition file by fileId. try { - Get-V2024FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID -XSailPointExperimental $XSailPointExperimental + Get-V2025FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID # Below is a request that includes all optional parameters - # Get-V2024FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID -XSailPointExperimental $XSailPointExperimental + # Get-V2025FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FileFromS3" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025FileFromS3" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/custom-forms#get-file-from-s3 + source: | + from sailpoint.v2025.api.custom_forms_api import CustomFormsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + form_definition_id = '00000000-0000-0000-0000-000000000000' # str | FormDefinitionID Form definition ID # str | FormDefinitionID Form definition ID + file_id = '00000031N0J7R2B57M8YG73J7M.png' # str | FileID String specifying the hashed name of the uploaded file we are retrieving. # str | FileID String specifying the hashed name of the uploaded file we are retrieving. + try: + # Download definition file by fileId. + + results = CustomFormsApi(api_client).get_file_from_s3(form_definition_id=form_definition_id, file_id=file_id) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).get_file_from_s3(form_definition_id, file_id) + print("The response of CustomFormsApi->get_file_from_s3:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CustomFormsApi->get_file_from_s3: %s\n" % e) /form-instances: get: tags: @@ -80508,22 +103971,24 @@ paths: content: application/json: schema: - type: object - properties: - count: - description: Count number of Results - type: integer - format: int64 - example: 1 - x-go-name: Count - results: - description: Results holds a list of FormInstanceResponse items - type: array - items: - $ref: '#/paths/~1form-instances/post/responses/201/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/FormInstanceResponse.yaml - x-go-name: Results - x-go-package: github.com/sailpoint/sp-forms/domain + type: array + items: + type: object + properties: + count: + description: Count number of Results + type: integer + format: int64 + example: 1 + x-go-name: Count + results: + description: Results holds a list of FormInstanceResponse items + type: array + items: + $ref: '#/paths/~1form-instances/post/responses/201/content/application~1json/schema' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormInstanceResponse.yaml + x-go-name: Results + x-go-package: github.com/sailpoint/sp-forms/domain '400': description: An error with the request occurred content: @@ -80538,7 +104003,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -80561,7 +104026,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -80584,7 +104049,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -80599,7 +104064,7 @@ paths: application/json: schema: $ref: '#/paths/~1form-definitions/get/responses/429/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/Error.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/Error.yaml '500': description: An internal server error occurred content: @@ -80614,7 +104079,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -80626,32 +104091,43 @@ paths: security: - userAuth: - sp:forms:manage - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#search-form-instances-by-tenant + label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#search-form-instances-by-tenant source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # List form instances by tenant. try { - Search-V2024FormInstancesByTenant -XSailPointExperimental $XSailPointExperimental + Search-V2025FormInstancesByTenant # Below is a request that includes all optional parameters - # Search-V2024FormInstancesByTenant -XSailPointExperimental $XSailPointExperimental + # Search-V2025FormInstancesByTenant } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormInstancesByTenant" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025FormInstancesByTenant" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/custom-forms#search-form-instances-by-tenant + source: | + from sailpoint.v2025.api.custom_forms_api import CustomFormsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.list_form_instances_by_tenant_response import ListFormInstancesByTenantResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List form instances by tenant. + + results = CustomFormsApi(api_client).search_form_instances_by_tenant() + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).search_form_instances_by_tenant() + print("The response of CustomFormsApi->search_form_instances_by_tenant:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CustomFormsApi->search_form_instances_by_tenant: %s\n" % e) post: tags: - Custom Forms @@ -80795,7 +104271,7 @@ paths: x-go-name: Created createdBy: $ref: '#/paths/~1form-instances/post/requestBody/content/application~1json/schema/properties/createdBy' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/FormInstanceCreatedBy.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormInstanceCreatedBy.yaml expire: description: Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record example: '2023-08-12T20:14:57.74486Z' @@ -80805,7 +104281,7 @@ paths: description: FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form items: $ref: '#/paths/~1form-definitions/post/requestBody/content/application~1json/schema/properties/formConditions/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/FormCondition.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormCondition.yaml type: array x-go-name: FormConditions formData: @@ -80825,7 +104301,7 @@ paths: description: FormElements is the configuration of the form, this would be a repeat of the fields from the form-config items: $ref: '#/paths/~1form-definitions/post/requestBody/content/application~1json/schema/properties/formElements/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/FormElement.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormElement.yaml type: array x-go-name: FormElements formErrors: @@ -80841,7 +104317,7 @@ paths: description: Messages is a list of web.ErrorMessage items items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml type: array x-go-name: Messages value: @@ -80875,7 +104351,7 @@ paths: description: Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it items: $ref: '#/paths/~1form-instances/post/requestBody/content/application~1json/schema/properties/recipients/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/FormInstanceRecipient.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormInstanceRecipient.yaml type: array x-go-name: Recipients standAloneForm: @@ -80928,7 +104404,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -80951,7 +104427,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -80974,7 +104450,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -80989,7 +104465,7 @@ paths: application/json: schema: $ref: '#/paths/~1form-definitions/get/responses/429/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/Error.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/Error.yaml '500': description: An internal server error occurred content: @@ -81004,7 +104480,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -81017,20 +104493,10 @@ paths: - userAuth: - sp:forms:manage x-codegen-request-body-name: Body - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#create-form-instance + label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#create-form-instance source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Body = @" { "formInput" : { @@ -81058,14 +104524,57 @@ paths: # Creates a form instance. try { - New-V2024FormInstance -XSailPointExperimental $XSailPointExperimental + New-V2025FormInstance # Below is a request that includes all optional parameters - # New-V2024FormInstance -XSailPointExperimental $XSailPointExperimental -Body $Result + # New-V2025FormInstance -Body $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormInstance" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025FormInstance" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/custom-forms#create-form-instance + source: | + from sailpoint.v2025.api.custom_forms_api import CustomFormsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.create_form_instance_request import CreateFormInstanceRequest + from sailpoint.v2025.models.form_instance_response import FormInstanceResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + body = '''{ + "formInput" : { + "input1" : "Sales" + }, + "standAloneForm" : false, + "createdBy" : { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "WORKFLOW_EXECUTION" + }, + "recipients" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "IDENTITY" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "IDENTITY" + } ], + "expire" : "2023-08-12T20:14:57.74486Z", + "formDefinitionId" : "00000000-0000-0000-0000-000000000000", + "state" : "ASSIGNED", + "ttl" : 1571827560 + }''' # CreateFormInstanceRequest | Body is the request payload to create a form instance (optional) + try: + # Creates a form instance. + + results = CustomFormsApi(api_client).create_form_instance() + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).create_form_instance(new_body) + print("The response of CustomFormsApi->create_form_instance:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CustomFormsApi->create_form_instance: %s\n" % e) /form-instances/{formInstanceID}: get: tags: @@ -81084,14 +104593,6 @@ paths: x-go-name: FormInstanceID example: 00000000-0000-0000-0000-000000000000 x-go-name: FormInstanceID - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true responses: '200': description: Returns a form instance by its key @@ -81099,7 +104600,7 @@ paths: application/json: schema: $ref: '#/paths/~1form-instances/post/responses/201/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/FormInstanceResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormInstanceResponse.yaml '400': description: An error with the request occurred content: @@ -81114,7 +104615,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -81137,7 +104638,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -81160,7 +104661,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -81183,7 +104684,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -81198,7 +104699,7 @@ paths: application/json: schema: $ref: '#/paths/~1form-definitions/get/responses/429/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/Error.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/Error.yaml '500': description: An internal server error occurred content: @@ -81213,7 +104714,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -81226,22 +104727,43 @@ paths: - userAuth: [] x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#get-form-instance-by-key + label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#get-form-instance-by-key source: | $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Returns a form instance. try { - Get-V2024FormInstanceByKey -FormInstanceID $FormInstanceID -XSailPointExperimental $XSailPointExperimental + Get-V2025FormInstanceByKey -FormInstanceID $FormInstanceID # Below is a request that includes all optional parameters - # Get-V2024FormInstanceByKey -FormInstanceID $FormInstanceID -XSailPointExperimental $XSailPointExperimental + # Get-V2025FormInstanceByKey -FormInstanceID $FormInstanceID } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormInstanceByKey" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025FormInstanceByKey" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/custom-forms#get-form-instance-by-key + source: | + from sailpoint.v2025.api.custom_forms_api import CustomFormsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.form_instance_response import FormInstanceResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + form_instance_id = '00000000-0000-0000-0000-000000000000' # str | Form instance ID # str | Form instance ID + try: + # Returns a form instance. + + results = CustomFormsApi(api_client).get_form_instance_by_key(form_instance_id=form_instance_id) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).get_form_instance_by_key(form_instance_id) + print("The response of CustomFormsApi->get_form_instance_by_key:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CustomFormsApi->get_form_instance_by_key: %s\n" % e) patch: tags: - Custom Forms @@ -81259,21 +104781,13 @@ paths: x-go-name: FormInstanceID example: 00000000-0000-0000-0000-000000000000 x-go-name: FormInstanceID - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true requestBody: description: 'Body is the request payload to patch a form instance, check: https://jsonpatch.com' content: application/json: schema: $ref: '#/paths/~1form-definitions~1%7BformDefinitionID%7D/patch/requestBody/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/Patch.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/Patch.yaml example: - op: replace path: /state @@ -81292,7 +104806,7 @@ paths: application/json: schema: $ref: '#/paths/~1form-instances/post/responses/201/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/FormInstanceResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormInstanceResponse.yaml '400': description: An error with the request occurred content: @@ -81307,7 +104821,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -81330,7 +104844,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -81353,7 +104867,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -81376,7 +104890,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -81399,7 +104913,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -81414,7 +104928,7 @@ paths: application/json: schema: $ref: '#/paths/~1form-definitions/get/responses/429/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/Error.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/Error.yaml '500': description: An internal server error occurred content: @@ -81429,7 +104943,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -81443,10 +104957,9 @@ paths: x-codegen-request-body-name: Body x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#patch-form-instance + label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#patch-form-instance source: | $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Body = @{ key_example = } # Map[] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional) $Body = @"[{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}]"@ @@ -81454,14 +104967,37 @@ paths: # Patch a form instance. try { - Update-V2024FormInstance -FormInstanceID $FormInstanceID -XSailPointExperimental $XSailPointExperimental + Update-V2025FormInstance -FormInstanceID $FormInstanceID # Below is a request that includes all optional parameters - # Update-V2024FormInstance -FormInstanceID $FormInstanceID -XSailPointExperimental $XSailPointExperimental -Body $Result + # Update-V2025FormInstance -FormInstanceID $FormInstanceID -Body $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024FormInstance" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025FormInstance" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/custom-forms#patch-form-instance + source: | + from sailpoint.v2025.api.custom_forms_api import CustomFormsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.form_instance_response import FormInstanceResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + form_instance_id = '00000000-0000-0000-0000-000000000000' # str | Form instance ID # str | Form instance ID + body = '''[{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}]''' # List[Dict[str, object]] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional) + try: + # Patch a form instance. + + results = CustomFormsApi(api_client).patch_form_instance(form_instance_id=form_instance_id) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).patch_form_instance(form_instance_id, new_body) + print("The response of CustomFormsApi->patch_form_instance:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CustomFormsApi->patch_form_instance: %s\n" % e) /form-instances/{formInstanceID}/data-source/{formElementID}: get: tags: @@ -81536,14 +105072,6 @@ paths: example: support required: false x-go-name: Query - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true responses: '200': description: Retrieves dynamic data to aid in correctly completing a valid form by form element ID from data source configuration @@ -81556,7 +105084,7 @@ paths: example: '{"results":[{"label":"Alfred 255e71dfc6e","subLabel":"Alfred.255e71dfc6e@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16676"},{"label":"Alize eba9d4cd27da","subLabel":"Alize.eba9d4cd27da@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f1667c"},{"label":"Antonina 01f69c3ea","subLabel":"Antonina.01f69c3ea@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f9667e"},{"label":"Ardella 21e78ce155","subLabel":"Ardella.21e78ce155@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e6667a"},{"label":"Arnaldo d8582b6e17","subLabel":"Arnaldo.d8582b6e17@testmail.identitysoon.com","value":"2c918084821847c5018227ced3426686"},{"label":"Aurelia admin24828","subLabel":"Aurelia.admin24828@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16674"},{"label":"Barbara 72ca418fdd","subLabel":"Barbara.72ca418fdd@testmail.identitysoon.com","value":"2c918084821847c5018227ced2fb6680"},{"label":"Barbara ee1a2436ee","subLabel":"Barbara.ee1a2436ee@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e56678"},{"label":"Baylee 652d72432f3","subLabel":"Baylee.652d72432f3@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aee"},{"label":"Brock e76b56ae4d49","subLabel":"Brock.e76b56ae4d49@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aef"}]}' items: $ref: '#/paths/~1form-definitions~1%7BformDefinitionID%7D~1data-source/post/responses/200/content/application~1json/schema/properties/results/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/FormElementDataSourceConfigOptions.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/FormElementDataSourceConfigOptions.yaml type: array x-go-name: Results type: object @@ -81575,7 +105103,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -81598,7 +105126,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -81621,7 +105149,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -81644,7 +105172,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -81659,7 +105187,7 @@ paths: application/json: schema: $ref: '#/paths/~1form-definitions/get/responses/429/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/Error.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/Error.yaml '500': description: An internal server error occurred content: @@ -81674,7 +105202,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -81687,11 +105215,10 @@ paths: - userAuth: [] x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#search-form-element-data-by-element-id + label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#search-form-element-data-by-element-id source: | $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID $FormElementID = "1" # String | Form element ID - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) $Filters = "value eq "ID01"" # 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` (optional) $Query = "support" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional) @@ -81699,14 +105226,40 @@ paths: # Retrieves dynamic data by element. try { - Search-V2024FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID -XSailPointExperimental $XSailPointExperimental + Search-V2025FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID # Below is a request that includes all optional parameters - # Search-V2024FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Filters $Filters -Query $Query + # Search-V2025FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID -Limit $Limit -Filters $Filters -Query $Query } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormElementDataByElementID" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025FormElementDataByElementID" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/custom-forms#search-form-element-data-by-element-id + source: | + from sailpoint.v2025.api.custom_forms_api import CustomFormsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.list_form_element_data_by_element_id_response import ListFormElementDataByElementIDResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + form_instance_id = '00000000-0000-0000-0000-000000000000' # str | Form instance ID # str | Form instance ID + form_element_id = '1' # str | Form element ID # str | Form element ID + limit = 250 # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + filters = 'value eq \"ID01\"' # 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (optional) + query = 'support' # str | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) # str | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) + try: + # Retrieves dynamic data by element. + + results = CustomFormsApi(api_client).search_form_element_data_by_element_id(form_instance_id=form_instance_id, form_element_id=form_element_id) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).search_form_element_data_by_element_id(form_instance_id, form_element_id, limit, filters, query) + print("The response of CustomFormsApi->search_form_element_data_by_element_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CustomFormsApi->search_form_element_data_by_element_id: %s\n" % e) /form-instances/{formInstanceID}/file/{fileID}: get: tags: @@ -81740,14 +105293,6 @@ paths: type: string x-go-name: FileID x-go-name: FileID - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true responses: '200': description: Returns a file that is referred to by fileID and associated with the formInstanceID @@ -81782,7 +105327,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -81802,7 +105347,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -81822,7 +105367,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -81842,7 +105387,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -81865,7 +105410,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -81885,7 +105430,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -81905,7 +105450,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -81925,7 +105470,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -81948,7 +105493,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -81968,7 +105513,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -81988,7 +105533,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -82008,7 +105553,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -82031,7 +105576,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -82051,7 +105596,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -82071,7 +105616,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -82091,7 +105636,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -82106,7 +105651,7 @@ paths: application/json: schema: $ref: '#/paths/~1form-definitions/get/responses/429/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/Error.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/Error.yaml '500': description: An internal server error occurred content: @@ -82121,7 +105666,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -82141,7 +105686,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -82161,7 +105706,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -82181,7 +105726,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -82204,7 +105749,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -82224,7 +105769,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -82244,7 +105789,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -82264,7 +105809,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -82279,23 +105824,44 @@ paths: x-codegen-request-body-name: Body x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#get-form-instance-file + label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#get-form-instance-file source: | $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | FormInstanceID Form instance ID $FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Download instance file by fileId. try { - Get-V2024FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID -XSailPointExperimental $XSailPointExperimental + Get-V2025FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID # Below is a request that includes all optional parameters - # Get-V2024FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID -XSailPointExperimental $XSailPointExperimental + # Get-V2025FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormInstanceFile" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025FormInstanceFile" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/custom-forms#get-form-instance-file + source: | + from sailpoint.v2025.api.custom_forms_api import CustomFormsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + form_instance_id = '00000000-0000-0000-0000-000000000000' # str | FormInstanceID Form instance ID # str | FormInstanceID Form instance ID + file_id = '00000031N0J7R2B57M8YG73J7M.png' # str | FileID String specifying the hashed name of the uploaded file we are retrieving. # str | FileID String specifying the hashed name of the uploaded file we are retrieving. + try: + # Download instance file by fileId. + + results = CustomFormsApi(api_client).get_form_instance_file(form_instance_id=form_instance_id, file_id=file_id) + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).get_form_instance_file(form_instance_id, file_id) + print("The response of CustomFormsApi->get_form_instance_file:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CustomFormsApi->get_form_instance_file: %s\n" % e) /form-definitions/predefined-select-options: get: tags: @@ -82335,7 +105901,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -82358,7 +105924,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -82381,7 +105947,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -82396,7 +105962,7 @@ paths: application/json: schema: $ref: '#/paths/~1form-definitions/get/responses/429/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/Error.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/Error.yaml '500': description: An internal server error occurred content: @@ -82411,7 +105977,7 @@ paths: type: array items: $ref: '#/paths/~1form-definitions/get/responses/400/content/application~1json/schema/properties/messages/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/forms/ErrorMessage.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/forms/ErrorMessage.yaml x-go-name: Messages statusCode: type: integer @@ -82423,32 +105989,43 @@ paths: security: - userAuth: - sp:forms:manage - parameters: - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/custom-forms#search-pre-defined-select-options + label: SDK_tools/sdk/powershell/v2025/methods/custom-forms#search-pre-defined-select-options source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # List predefined select options. try { - Search-V2024PreDefinedSelectOptions -XSailPointExperimental $XSailPointExperimental + Search-V2025PreDefinedSelectOptions # Below is a request that includes all optional parameters - # Search-V2024PreDefinedSelectOptions -XSailPointExperimental $XSailPointExperimental + # Search-V2025PreDefinedSelectOptions } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024PreDefinedSelectOptions" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025PreDefinedSelectOptions" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/custom-forms#search-pre-defined-select-options + source: | + from sailpoint.v2025.api.custom_forms_api import CustomFormsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.list_predefined_select_options_response import ListPredefinedSelectOptionsResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List predefined select options. + + results = CustomFormsApi(api_client).search_pre_defined_select_options() + # Below is a request that includes all optional parameters + # results = CustomFormsApi(api_client).search_pre_defined_select_options() + print("The response of CustomFormsApi->search_pre_defined_select_options:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CustomFormsApi->search_pre_defined_select_options: %s\n" % e) /access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type}: get: tags: @@ -82543,22 +106120,22 @@ paths: example: true '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/access-request-identity-metrics#get-access-request-identity-metrics + label: SDK_tools/sdk/powershell/v2025/methods/access-request-identity-metrics#get-access-request-identity-metrics source: | $IdentityId = "7025c863-c270-4ba6-beea-edf3cb091573" # String | Manager's identity ID. $RequestedObjectId = "2db501be-f0fb-4cc5-a695-334133c52891" # String | Requested access item's ID. @@ -82567,14 +106144,37 @@ paths: # Return access request identity metrics try { - Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type + Get-V2025AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type # Below is a request that includes all optional parameters - # Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type + # Get-V2025AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestIdentityMetrics" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestIdentityMetrics" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/access-request-identity-metrics#get-access-request-identity-metrics + source: | + from sailpoint.v2025.api.access_request_identity_metrics_api import AccessRequestIdentityMetricsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_id = '7025c863-c270-4ba6-beea-edf3cb091573' # str | Manager's identity ID. # str | Manager's identity ID. + requested_object_id = '2db501be-f0fb-4cc5-a695-334133c52891' # str | Requested access item's ID. # str | Requested access item's ID. + type = 'ENTITLEMENT' # str | Requested access item's type. # str | Requested access item's type. + try: + # Return access request identity metrics + + results = AccessRequestIdentityMetricsApi(api_client).get_access_request_identity_metrics(identity_id=identity_id, requested_object_id=requested_object_id, type=type) + # Below is a request that includes all optional parameters + # results = AccessRequestIdentityMetricsApi(api_client).get_access_request_identity_metrics(identity_id, requested_object_id, type) + print("The response of AccessRequestIdentityMetricsApi->get_access_request_identity_metrics:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccessRequestIdentityMetricsApi->get_access_request_identity_metrics: %s\n" % e) /icons/{objectType}/{objectId}: put: operationId: setIcon @@ -82639,25 +106239,25 @@ paths: example: '' '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/icons#set-icon + label: SDK_tools/sdk/powershell/v2025/methods/icons#set-icon source: | $ObjectType = "application" # String | Object type. Available options ['application'] $ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. @@ -82667,14 +106267,40 @@ paths: # Update an icon try { - Set-V2024Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental -Image $Image + Set-V2025Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental -Image $Image # Below is a request that includes all optional parameters - # Set-V2024Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental -Image $Image + # Set-V2025Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental -Image $Image } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024Icon" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025Icon" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/icons#set-icon + source: | + from sailpoint.v2025.api.icons_api import IconsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.set_icon200_response import SetIcon200Response + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + object_type = 'application' # str | Object type. Available options ['application'] # str | Object type. Available options ['application'] + object_id = 'a291e870-48c3-4953-b656-fb5ce2a93169' # str | Object id. # str | Object id. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + image = None # bytearray | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] # bytearray | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] + try: + # Update an icon + + results = IconsApi(api_client).set_icon(object_type=object_type, object_id=object_id, x_sail_point_experimental=x_sail_point_experimental, image=image) + # Below is a request that includes all optional parameters + # results = IconsApi(api_client).set_icon(object_type, object_id, x_sail_point_experimental, image) + print("The response of IconsApi->set_icon:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IconsApi->set_icon: %s\n" % e) delete: operationId: deleteIcon tags: @@ -82713,28 +106339,28 @@ paths: responses: '204': $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/204.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/icons#delete-icon + label: SDK_tools/sdk/powershell/v2025/methods/icons#delete-icon source: | $ObjectType = "application" # String | Object type. Available options ['application'] $ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. @@ -82743,14 +106369,36 @@ paths: # Delete an icon try { - Remove-V2024Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental + Remove-V2025Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Remove-V2024Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental + # Remove-V2025Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Icon" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Icon" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/icons#delete-icon + source: | + from sailpoint.v2025.api.icons_api import IconsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + object_type = 'application' # str | Object type. Available options ['application'] # str | Object type. Available options ['application'] + object_id = 'a291e870-48c3-4953-b656-fb5ce2a93169' # str | Object id. # str | Object id. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Delete an icon + + IconsApi(api_client).delete_icon(object_type=object_type, object_id=object_id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # IconsApi(api_client).delete_icon(object_type, object_id, x_sail_point_experimental) + except Exception as e: + print("Exception when calling IconsApi->delete_icon: %s\n" % e) /suggested-entitlement-description-batches/{batchId}/stats: get: tags: @@ -82808,22 +106456,22 @@ paths: type: integer '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:sed:read @@ -82832,21 +106480,43 @@ paths: - SOURCE_ADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#get-sed-batch-stats + label: SDK_tools/sdk/powershell/v2025/methods/suggested-entitlement-description#get-sed-batch-stats source: | $BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id # Submit Sed Batch Stats Request try { - Get-V2024SedBatchStats -BatchId $BatchId + Get-V2025SedBatchStats -BatchId $BatchId # Below is a request that includes all optional parameters - # Get-V2024SedBatchStats -BatchId $BatchId + # Get-V2025SedBatchStats -BatchId $BatchId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatchStats" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SedBatchStats" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/suggested-entitlement-description#get-sed-batch-stats + source: | + from sailpoint.v2025.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sed_batch_stats import SedBatchStats + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + batch_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | Batch Id # str | Batch Id + try: + # Submit Sed Batch Stats Request + + results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batch_stats(batch_id=batch_id) + # Below is a request that includes all optional parameters + # results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batch_stats(batch_id) + print("The response of SuggestedEntitlementDescriptionApi->get_sed_batch_stats:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batch_stats: %s\n" % e) /suggested-entitlement-description-batches: get: tags: @@ -82871,22 +106541,22 @@ paths: example: OK '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:sed:read @@ -82895,20 +106565,41 @@ paths: - SOURCE_ADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#get-sed-batches + label: SDK_tools/sdk/powershell/v2025/methods/suggested-entitlement-description#get-sed-batches source: | # List Sed Batch Request try { - Get-V2024SedBatches + Get-V2025SedBatches # Below is a request that includes all optional parameters - # Get-V2024SedBatches + # Get-V2025SedBatches } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatches" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SedBatches" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/suggested-entitlement-description#get-sed-batches + source: | + from sailpoint.v2025.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sed_batch_status import SedBatchStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Sed Batch Request + + results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batches() + # Below is a request that includes all optional parameters + # results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batches() + print("The response of SuggestedEntitlementDescriptionApi->get_sed_batches:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->get_sed_batches: %s\n" % e) post: tags: - Suggested Entitlement Description @@ -82956,22 +106647,22 @@ paths: example: 016629d1-1d25-463f-97f3-c6686846650 '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:sed:write @@ -82980,7 +106671,7 @@ paths: - SOURCE_ADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#submit-sed-batch-request + label: SDK_tools/sdk/powershell/v2025/methods/suggested-entitlement-description#submit-sed-batch-request source: | $SedBatchRequest = @" { @@ -82992,14 +106683,40 @@ paths: # Submit Sed Batch Request try { - Submit-V2024SedBatchRequest + Submit-V2025SedBatchRequest # Below is a request that includes all optional parameters - # Submit-V2024SedBatchRequest -SedBatchRequest $Result + # Submit-V2025SedBatchRequest -SedBatchRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedBatchRequest" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2025SedBatchRequest" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/suggested-entitlement-description#submit-sed-batch-request + source: | + from sailpoint.v2025.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sed_batch_request import SedBatchRequest + from sailpoint.v2025.models.sed_batch_response import SedBatchResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + sed_batch_request = '''{ + "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], + "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] + }''' # SedBatchRequest | Sed Batch Request (optional) + try: + # Submit Sed Batch Request + + results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_batch_request() + # Below is a request that includes all optional parameters + # results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_batch_request(new_sed_batch_request) + print("The response of SuggestedEntitlementDescriptionApi->submit_sed_batch_request:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_batch_request: %s\n" % e) /suggested-entitlement-description-approvals: post: tags: @@ -83053,22 +106770,22 @@ paths: type: array '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:sed:write @@ -83077,7 +106794,7 @@ paths: - SOURCE_ADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#submit-sed-approval + label: SDK_tools/sdk/powershell/v2025/methods/suggested-entitlement-description#submit-sed-approval source: | $SedApproval = @"{ "items" : "016629d1-1d25-463f-97f3-c6686846650" @@ -83088,14 +106805,37 @@ paths: try { $Result = ConvertFrom-JsonToSedApproval -Json $SedApproval - Submit-V2024SedApproval -SedApproval $Result + Submit-V2025SedApproval -SedApproval $Result # Below is a request that includes all optional parameters - # Submit-V2024SedApproval -SedApproval $Result + # Submit-V2025SedApproval -SedApproval $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedApproval" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2025SedApproval" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/suggested-entitlement-description#submit-sed-approval + source: | + from sailpoint.v2025.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sed_approval import SedApproval + from sailpoint.v2025.models.sed_approval_status import SedApprovalStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + sed_approval = '''[sailpoint.v2025.SedApproval()]''' # List[SedApproval] | Sed Approval + try: + # Submit Bulk Approval Request + new_sed_approval = SedApproval.from_json(sed_approval) + results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(sed_approval=new_sed_approval) + # Below is a request that includes all optional parameters + # results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(new_sed_approval) + print("The response of SuggestedEntitlementDescriptionApi->submit_sed_approval:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_approval: %s\n" % e) /suggested-entitlement-description-assignments: post: tags: @@ -83164,22 +106904,22 @@ paths: example: 016629d1-1d25-463f-97f3-c6686846650 '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:sed:write @@ -83188,7 +106928,7 @@ paths: - SOURCE_ADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#submit-sed-assignment + label: SDK_tools/sdk/powershell/v2025/methods/suggested-entitlement-description#submit-sed-assignment source: | $SedAssignment = @" { @@ -83204,14 +106944,43 @@ paths: try { $Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment - Submit-V2024SedAssignment -SedAssignment $Result + Submit-V2025SedAssignment -SedAssignment $Result # Below is a request that includes all optional parameters - # Submit-V2024SedAssignment -SedAssignment $Result + # Submit-V2025SedAssignment -SedAssignment $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedAssignment" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2025SedAssignment" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/suggested-entitlement-description#submit-sed-assignment + source: | + from sailpoint.v2025.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sed_assignment import SedAssignment + from sailpoint.v2025.models.sed_assignment_response import SedAssignmentResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + sed_assignment = '''{ + "assignee" : { + "type" : "SOURCE_OWNER", + "value" : "016629d1-1d25-463f-97f3-c6686846650" + }, + "items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ] + }''' # SedAssignment | Sed Assignment Request + try: + # Submit Sed Assignment Request + new_sed_assignment = SedAssignment.from_json(sed_assignment) + results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_assignment(sed_assignment=new_sed_assignment) + # Below is a request that includes all optional parameters + # results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_assignment(new_sed_assignment) + print("The response of SuggestedEntitlementDescriptionApi->submit_sed_assignment:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_assignment: %s\n" % e) /suggested-entitlement-descriptions: get: tags: @@ -83235,12 +107004,12 @@ paths: **fullText**: will filter suggested entitlement description records by text found in any of the following fields: entitlement name, entitlement display name, suggested description, source name parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - description: |- Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) @@ -83372,22 +107141,22 @@ paths: type: array '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:sed:read @@ -83397,7 +107166,7 @@ paths: - SOURCE_SUBADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#list-seds + label: SDK_tools/sdk/powershell/v2025/methods/suggested-entitlement-description#list-seds source: | $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) @@ -83411,14 +107180,43 @@ paths: # List Suggested Entitlement Descriptions try { - Get-V2024Seds + Get-V2025Seds # Below is a request that includes all optional parameters - # Get-V2024Seds -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -CountOnly $CountOnly -RequestedByAnyone $RequestedByAnyone -ShowPendingStatusOnly $ShowPendingStatusOnly + # Get-V2025Seds -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -CountOnly $CountOnly -RequestedByAnyone $RequestedByAnyone -ShowPendingStatusOnly $ShowPendingStatusOnly } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Seds" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Seds" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/suggested-entitlement-description#list-seds + source: | + from sailpoint.v2025.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sed import Sed + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + 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) + filters = 'displayName co \"Read and Write\"' # 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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) + sorters = 'sorters=displayName' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status** (optional) + count_only = 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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to False) + requested_by_anyone = False # bool | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to False) # bool | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to False) + show_pending_status_only = False # bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) (default to False) # bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) (default to False) + try: + # List Suggested Entitlement Descriptions + + results = SuggestedEntitlementDescriptionApi(api_client).list_seds() + # Below is a request that includes all optional parameters + # results = SuggestedEntitlementDescriptionApi(api_client).list_seds(limit, offset, count, filters, sorters, count_only, requested_by_anyone, show_pending_status_only) + print("The response of SuggestedEntitlementDescriptionApi->list_seds:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->list_seds: %s\n" % e) patch: tags: - Suggested Entitlement Description @@ -83464,25 +107262,25 @@ paths: application/json: schema: $ref: '#/paths/~1suggested-entitlement-descriptions/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/Sed.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Sed.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml security: - userAuth: - idn:sed:write @@ -83492,7 +107290,7 @@ paths: - SOURCE_SUBADMIN x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#patch-sed + label: SDK_tools/sdk/powershell/v2025/methods/suggested-entitlement-description#patch-sed source: | $Id = "ebab396f-0af1-4050-89b7-dafc63ec70e7" # String | id is sed id $SedPatch = @"{ @@ -83506,14 +107304,38 @@ paths: try { $Result = ConvertFrom-JsonToSedPatch -Json $SedPatch - Update-V2024Sed -Id $Id -SedPatch $Result + Update-V2025Sed -Id $Id -SedPatch $Result # Below is a request that includes all optional parameters - # Update-V2024Sed -Id $Id -SedPatch $Result + # Update-V2025Sed -Id $Id -SedPatch $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Sed" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Sed" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/suggested-entitlement-description#patch-sed + source: | + from sailpoint.v2025.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.sed import Sed + from sailpoint.v2025.models.sed_patch import SedPatch + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ebab396f-0af1-4050-89b7-dafc63ec70e7' # str | id is sed id # str | id is sed id + sed_patch = '''[sailpoint.v2025.SedPatch()]''' # List[SedPatch] | Sed Patch Request + try: + # Patch Suggested Entitlement Description + new_sed_patch = SedPatch.from_json(sed_patch) + results = SuggestedEntitlementDescriptionApi(api_client).patch_sed(id=id, sed_patch=new_sed_patch) + # Below is a request that includes all optional parameters + # results = SuggestedEntitlementDescriptionApi(api_client).patch_sed(id, new_sed_patch) + print("The response of SuggestedEntitlementDescriptionApi->patch_sed:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SuggestedEntitlementDescriptionApi->patch_sed: %s\n" % e) /discovered-applications: get: operationId: getDiscoveredApplications @@ -83526,10 +107348,10 @@ paths: - userAuth: - idn:application-discovery:read parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - in: query name: detail schema: @@ -83793,22 +107615,22 @@ paths: associatedSources: [] '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/application-discovery#get-discovered-applications + label: SDK_tools/sdk/powershell/v2025/methods/application-discovery#get-discovered-applications source: | $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) @@ -83819,14 +107641,40 @@ paths: # Get Discovered Applications for Tenant try { - Get-V2024DiscoveredApplications + Get-V2025DiscoveredApplications # Below is a request that includes all optional parameters - # Get-V2024DiscoveredApplications -Limit $Limit -Offset $Offset -Detail $Detail -Filter $Filter -Sorters $Sorters + # Get-V2025DiscoveredApplications -Limit $Limit -Offset $Offset -Detail $Detail -Filter $Filter -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DiscoveredApplications" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DiscoveredApplications" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/application-discovery#get-discovered-applications + source: | + from sailpoint.v2025.api.application_discovery_api import ApplicationDiscoveryApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.get_discovered_applications200_response_inner import GetDiscoveredApplications200ResponseInner + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + 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) + detail = 'FULL' # str | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) # str | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) + filter = 'name eq \"Okta\" and description co \"Okta\" and discoverySource in (\"csv\", \"Okta Saas\")' # 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: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (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: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional) + try: + # Get Discovered Applications for Tenant + + results = ApplicationDiscoveryApi(api_client).get_discovered_applications() + # Below is a request that includes all optional parameters + # results = ApplicationDiscoveryApi(api_client).get_discovered_applications(limit, offset, detail, filter, sorters) + print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e) /manual-discover-applications-template: get: summary: Download CSV Template for Discovery @@ -83861,35 +107709,56 @@ paths: Example Application,Example Description '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/application-discovery#get-manual-discover-applications-csv-template + label: SDK_tools/sdk/powershell/v2025/methods/application-discovery#get-manual-discover-applications-csv-template source: | # Download CSV Template for Discovery try { - Get-V2024ManualDiscoverApplicationsCsvTemplate + Get-V2025ManualDiscoverApplicationsCsvTemplate # Below is a request that includes all optional parameters - # Get-V2024ManualDiscoverApplicationsCsvTemplate + # Get-V2025ManualDiscoverApplicationsCsvTemplate } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManualDiscoverApplicationsCsvTemplate" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManualDiscoverApplicationsCsvTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/application-discovery#get-manual-discover-applications-csv-template + source: | + from sailpoint.v2025.api.application_discovery_api import ApplicationDiscoveryApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.manual_discover_applications_template import ManualDiscoverApplicationsTemplate + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Download CSV Template for Discovery + + results = ApplicationDiscoveryApi(api_client).get_manual_discover_applications_csv_template() + # Below is a request that includes all optional parameters + # results = ApplicationDiscoveryApi(api_client).get_manual_discover_applications_csv_template() + print("The response of ApplicationDiscoveryApi->get_manual_discover_applications_csv_template:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ApplicationDiscoveryApi->get_manual_discover_applications_csv_template: %s\n" % e) /manual-discover-applications: post: summary: Upload CSV to Discover Applications @@ -83923,36 +107792,55 @@ paths: description: The CSV has been successfully processed. '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/application-discovery#send-manual-discover-applications-csv-template + label: SDK_tools/sdk/powershell/v2025/methods/application-discovery#send-manual-discover-applications-csv-template source: | $File = # System.IO.FileInfo | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. # Upload CSV to Discover Applications try { - Send-V2024ManualDiscoverApplicationsCsvTemplate -File $File + Send-V2025ManualDiscoverApplicationsCsvTemplate -File $File # Below is a request that includes all optional parameters - # Send-V2024ManualDiscoverApplicationsCsvTemplate -File $File + # Send-V2025ManualDiscoverApplicationsCsvTemplate -File $File } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ManualDiscoverApplicationsCsvTemplate" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025ManualDiscoverApplicationsCsvTemplate" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/application-discovery#send-manual-discover-applications-csv-template + source: | + from sailpoint.v2025.api.application_discovery_api import ApplicationDiscoveryApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + file = None # bytearray | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. # bytearray | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. + try: + # Upload CSV to Discover Applications + + ApplicationDiscoveryApi(api_client).send_manual_discover_applications_csv_template(file=file) + # Below is a request that includes all optional parameters + # ApplicationDiscoveryApi(api_client).send_manual_discover_applications_csv_template(file) + except Exception as e: + print("Exception when calling ApplicationDiscoveryApi->send_manual_discover_applications_csv_template: %s\n" % e) /vendor-connector-mappings: get: security: @@ -84090,38 +107978,59 @@ paths: Valid: false '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '405': $ref: '#/paths/~1verified-domains/post/responses/405' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/405.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/405.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/vendor-connector-mappings#get-vendor-connector-mappings + label: SDK_tools/sdk/powershell/v2025/methods/vendor-connector-mappings#get-vendor-connector-mappings source: | # List Vendor Connector Mappings try { - Get-V2024VendorConnectorMappings + Get-V2025VendorConnectorMappings # Below is a request that includes all optional parameters - # Get-V2024VendorConnectorMappings + # Get-V2025VendorConnectorMappings } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024VendorConnectorMappings" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025VendorConnectorMappings" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/vendor-connector-mappings#get-vendor-connector-mappings + source: | + from sailpoint.v2025.api.vendor_connector_mappings_api import VendorConnectorMappingsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.vendor_connector_mapping import VendorConnectorMapping + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List Vendor Connector Mappings + + results = VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings() + # Below is a request that includes all optional parameters + # results = VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings() + print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) post: security: - userAuth: @@ -84138,7 +108047,7 @@ paths: application/json: schema: $ref: '#/paths/~1vendor-connector-mappings/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/VendorConnectorMapping.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/VendorConnectorMapping.yaml responses: '200': description: Successfully created a new vendor connector mapping. @@ -84146,28 +108055,28 @@ paths: application/json: schema: $ref: '#/paths/~1vendor-connector-mappings/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/VendorConnectorMapping.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/VendorConnectorMapping.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '405': $ref: '#/paths/~1verified-domains/post/responses/405' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/405.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/405.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/vendor-connector-mappings#create-vendor-connector-mapping + label: SDK_tools/sdk/powershell/v2025/methods/vendor-connector-mappings#create-vendor-connector-mapping source: | $VendorConnectorMapping = @" { @@ -84199,14 +108108,58 @@ paths: try { $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping - New-V2024VendorConnectorMapping -VendorConnectorMapping $Result + New-V2025VendorConnectorMapping -VendorConnectorMapping $Result # Below is a request that includes all optional parameters - # New-V2024VendorConnectorMapping -VendorConnectorMapping $Result + # New-V2025VendorConnectorMapping -VendorConnectorMapping $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024VendorConnectorMapping" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025VendorConnectorMapping" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/vendor-connector-mappings#create-vendor-connector-mapping + source: | + from sailpoint.v2025.api.vendor_connector_mappings_api import VendorConnectorMappingsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.vendor_connector_mapping import VendorConnectorMapping + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + vendor_connector_mapping = '''{ + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + }''' # VendorConnectorMapping | + try: + # Create Vendor Connector Mapping + new_vendor_connector_mapping = VendorConnectorMapping.from_json(vendor_connector_mapping) + results = VendorConnectorMappingsApi(api_client).create_vendor_connector_mapping(vendor_connector_mapping=new_vendor_connector_mapping) + # Below is a request that includes all optional parameters + # results = VendorConnectorMappingsApi(api_client).create_vendor_connector_mapping(new_vendor_connector_mapping) + print("The response of VendorConnectorMappingsApi->create_vendor_connector_mapping:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->create_vendor_connector_mapping: %s\n" % e) delete: security: - userAuth: @@ -84223,7 +108176,7 @@ paths: application/json: schema: $ref: '#/paths/~1vendor-connector-mappings/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/VendorConnectorMapping.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/VendorConnectorMapping.yaml responses: '200': description: Successfully deleted the specified vendor connector mapping. @@ -84238,25 +108191,25 @@ paths: example: 1 '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/vendor-connector-mappings#delete-vendor-connector-mapping + label: SDK_tools/sdk/powershell/v2025/methods/vendor-connector-mappings#delete-vendor-connector-mapping source: | $VendorConnectorMapping = @" { @@ -84288,14 +108241,59 @@ paths: try { $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping - Remove-V2024VendorConnectorMapping -VendorConnectorMapping $Result + Remove-V2025VendorConnectorMapping -VendorConnectorMapping $Result # Below is a request that includes all optional parameters - # Remove-V2024VendorConnectorMapping -VendorConnectorMapping $Result + # Remove-V2025VendorConnectorMapping -VendorConnectorMapping $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024VendorConnectorMapping" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025VendorConnectorMapping" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/vendor-connector-mappings#delete-vendor-connector-mapping + source: | + from sailpoint.v2025.api.vendor_connector_mappings_api import VendorConnectorMappingsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.delete_vendor_connector_mapping200_response import DeleteVendorConnectorMapping200Response + from sailpoint.v2025.models.vendor_connector_mapping import VendorConnectorMapping + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + vendor_connector_mapping = '''{ + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + }''' # VendorConnectorMapping | + try: + # Delete Vendor Connector Mapping + new_vendor_connector_mapping = VendorConnectorMapping.from_json(vendor_connector_mapping) + results = VendorConnectorMappingsApi(api_client).delete_vendor_connector_mapping(vendor_connector_mapping=new_vendor_connector_mapping) + # Below is a request that includes all optional parameters + # results = VendorConnectorMappingsApi(api_client).delete_vendor_connector_mapping(new_vendor_connector_mapping) + print("The response of VendorConnectorMappingsApi->delete_vendor_connector_mapping:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling VendorConnectorMappingsApi->delete_vendor_connector_mapping: %s\n" % e) /source-apps/{id}: get: operationId: getSourceApp @@ -84405,7 +108403,7 @@ paths: description: The password policies for the source items: $ref: '#/components/schemas/Account/allOf/1/properties/ownerIdentity/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/BaseReferenceDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BaseReferenceDto.yaml example: - type: PASSWORD_POLICY id: 006a072ecc6647f68bba9f4a4ad34649 @@ -84415,7 +108413,7 @@ paths: nullable: true allOf: - $ref: '#/components/schemas/Account/allOf/1/properties/ownerIdentity/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/BaseReferenceDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BaseReferenceDto.yaml description: The owner of source app example: id: 85d173e7d57e496569df763231d6deb6a @@ -84423,25 +108421,25 @@ paths: name: John Doe '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/apps#get-source-app + label: SDK_tools/sdk/powershell/v2025/methods/apps#get-source-app source: | $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -84449,14 +108447,38 @@ paths: # Get source app by ID try { - Get-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2025SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental + # Get-V2025SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceApp" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SourceApp" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/apps#get-source-app + source: | + from sailpoint.v2025.api.apps_api import AppsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.source_app import SourceApp + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Get source app by ID + + results = AppsApi(api_client).get_source_app(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).get_source_app(id, x_sail_point_experimental) + print("The response of AppsApi->get_source_app:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AppsApi->get_source_app: %s\n" % e) patch: operationId: patchSourceApp tags: @@ -84493,7 +108515,7 @@ paths: type: array items: $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/JsonPatchOperation.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml example: - op: replace path: /enabled @@ -84637,7 +108659,7 @@ paths: description: The password policies for the source items: $ref: '#/components/schemas/Account/allOf/1/properties/ownerIdentity/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/BaseReferenceDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BaseReferenceDto.yaml example: - type: PASSWORD_POLICY id: 006a072ecc6647f68bba9f4a4ad34649 @@ -84647,7 +108669,7 @@ paths: nullable: true allOf: - $ref: '#/components/schemas/Account/allOf/1/properties/ownerIdentity/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/BaseReferenceDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BaseReferenceDto.yaml description: The owner of source app example: id: 85d173e7d57e496569df763231d6deb6a @@ -84655,25 +108677,25 @@ paths: name: John Doe '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/apps#patch-source-app + label: SDK_tools/sdk/powershell/v2025/methods/apps#patch-source-app source: | $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app to patch $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -84687,14 +108709,40 @@ paths: # Patch source app by ID try { - Update-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental + Update-V2025SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Update-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + # Update-V2025SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceApp" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SourceApp" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/apps#patch-source-app + source: | + from sailpoint.v2025.api.apps_api import AppsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2025.models.source_app_patch_dto import SourceAppPatchDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121e121518' # str | ID of the source app to patch # str | ID of the source app to patch + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch_operation = '''[{op=replace, path=/enabled, value=true}, {op=replace, path=/matchAllAccounts, value=true}]''' # List[JsonPatchOperation] | (optional) + try: + # Patch source app by ID + + results = AppsApi(api_client).patch_source_app(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).patch_source_app(id, x_sail_point_experimental, new_json_patch_operation) + print("The response of AppsApi->patch_source_app:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AppsApi->patch_source_app: %s\n" % e) delete: operationId: deleteSourceApp security: @@ -84729,25 +108777,25 @@ paths: application/json: schema: $ref: '#/paths/~1source-apps~1%7Bid%7D/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/app/SourceApp.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/app/SourceApp.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/apps#delete-source-app + label: SDK_tools/sdk/powershell/v2025/methods/apps#delete-source-app source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | source app ID. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -84755,14 +108803,38 @@ paths: # Delete source app by ID try { - Remove-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental + Remove-V2025SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Remove-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental + # Remove-V2025SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SourceApp" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SourceApp" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/apps#delete-source-app + source: | + from sailpoint.v2025.api.apps_api import AppsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.source_app import SourceApp + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '2c9180835d191a86015d28455b4a2329' # str | source app ID. # str | source app ID. + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + try: + # Delete source app by ID + + results = AppsApi(api_client).delete_source_app(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).delete_source_app(id, x_sail_point_experimental) + print("The response of AppsApi->delete_source_app:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AppsApi->delete_source_app: %s\n" % e) /source-apps/bulk-update: post: operationId: updateSourceAppsInBulk @@ -84805,7 +108877,7 @@ paths: type: array items: $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/JsonPatchOperation.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml description: The JSONPatch payload used to update the source app. example: - op: replace @@ -84820,28 +108892,28 @@ paths: responses: '204': $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/204.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/204.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/apps#update-source-apps-in-bulk + label: SDK_tools/sdk/powershell/v2025/methods/apps#update-source-apps-in-bulk source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $SourceAppBulkUpdateRequest = @" @@ -84862,14 +108934,47 @@ paths: # Bulk update source apps try { - Update-V2024SourceAppsInBulk -XSailPointExperimental $XSailPointExperimental + Update-V2025SourceAppsInBulk -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Update-V2024SourceAppsInBulk -XSailPointExperimental $XSailPointExperimental -SourceAppBulkUpdateRequest $Result + # Update-V2025SourceAppsInBulk -XSailPointExperimental $XSailPointExperimental -SourceAppBulkUpdateRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceAppsInBulk" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SourceAppsInBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/apps#update-source-apps-in-bulk + source: | + from sailpoint.v2025.api.apps_api import AppsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.source_app_bulk_update_request import SourceAppBulkUpdateRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + source_app_bulk_update_request = '''{ + "appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], + "jsonPatch" : [ { + "op" : "replace", + "path" : "/enabled", + "value" : false + }, { + "op" : "replace", + "path" : "/matchAllAccounts", + "value" : false + } ] + }''' # SourceAppBulkUpdateRequest | (optional) + try: + # Bulk update source apps + + AppsApi(api_client).update_source_apps_in_bulk(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # AppsApi(api_client).update_source_apps_in_bulk(x_sail_point_experimental, new_source_app_bulk_update_request) + except Exception as e: + print("Exception when calling AppsApi->update_source_apps_in_bulk: %s\n" % e) /source-apps/assigned: get: operationId: listAssignedSourceApp @@ -84881,12 +108986,12 @@ paths: - idn:app-roles:read description: This API returns the list of source apps assigned for logged in user. parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - in: query name: sorters schema: @@ -84939,25 +109044,25 @@ paths: type: array items: $ref: '#/paths/~1source-apps~1%7Bid%7D/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/app/SourceApp.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/app/SourceApp.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/apps#list-assigned-source-app + label: SDK_tools/sdk/powershell/v2025/methods/apps#list-assigned-source-app source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $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) @@ -84969,14 +109074,42 @@ paths: # List assigned source apps try { - Get-V2024AssignedSourceApp -XSailPointExperimental $XSailPointExperimental + Get-V2025AssignedSourceApp -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024AssignedSourceApp -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters + # Get-V2025AssignedSourceApp -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AssignedSourceApp" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AssignedSourceApp" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/apps#list-assigned-source-app + source: | + from sailpoint.v2025.api.apps_api import AppsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.source_app import SourceApp + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + 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) + 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) + sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, accountSource.id** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, accountSource.id** (optional) + filters = 'name eq \"source app name\"' # 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: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (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: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) + try: + # List assigned source apps + + results = AppsApi(api_client).list_assigned_source_app(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).list_assigned_source_app(x_sail_point_experimental, limit, count, offset, sorters, filters) + print("The response of AppsApi->list_assigned_source_app:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AppsApi->list_assigned_source_app: %s\n" % e) /source-apps: get: operationId: listAvailableSourceApps @@ -84988,12 +109121,12 @@ paths: - idn:app-roles:read description: This API returns the list of source apps available for access request. parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - in: query name: sorters schema: @@ -85046,25 +109179,25 @@ paths: type: array items: $ref: '#/paths/~1source-apps~1%7Bid%7D/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/app/SourceApp.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/app/SourceApp.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/apps#list-available-source-apps + label: SDK_tools/sdk/powershell/v2025/methods/apps#list-available-source-apps source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $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) @@ -85076,14 +109209,42 @@ paths: # List available source apps try { - Get-V2024AvailableSourceApps -XSailPointExperimental $XSailPointExperimental + Get-V2025AvailableSourceApps -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024AvailableSourceApps -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters + # Get-V2025AvailableSourceApps -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AvailableSourceApps" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AvailableSourceApps" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/apps#list-available-source-apps + source: | + from sailpoint.v2025.api.apps_api import AppsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.source_app import SourceApp + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + 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) + 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) + sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) + filters = 'name eq \"source app name\"' # 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: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (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: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) + try: + # List available source apps + + results = AppsApi(api_client).list_available_source_apps(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).list_available_source_apps(x_sail_point_experimental, limit, count, offset, sorters, filters) + print("The response of AppsApi->list_available_source_apps:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AppsApi->list_available_source_apps: %s\n" % e) post: operationId: createSourceApp tags: @@ -85158,25 +109319,25 @@ paths: application/json: schema: $ref: '#/paths/~1source-apps~1%7Bid%7D/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/app/SourceApp.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/app/SourceApp.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/apps#create-source-app + label: SDK_tools/sdk/powershell/v2025/methods/apps#create-source-app source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $SourceAppCreateDto = @" @@ -85196,14 +109357,48 @@ paths: try { $Result = ConvertFrom-JsonToSourceAppCreateDto -Json $SourceAppCreateDto - New-V2024SourceApp -XSailPointExperimental $XSailPointExperimental -SourceAppCreateDto $Result + New-V2025SourceApp -XSailPointExperimental $XSailPointExperimental -SourceAppCreateDto $Result # Below is a request that includes all optional parameters - # New-V2024SourceApp -XSailPointExperimental $XSailPointExperimental -SourceAppCreateDto $Result + # New-V2025SourceApp -XSailPointExperimental $XSailPointExperimental -SourceAppCreateDto $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourceApp" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SourceApp" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/apps#create-source-app + source: | + from sailpoint.v2025.api.apps_api import AppsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.source_app import SourceApp + from sailpoint.v2025.models.source_app_create_dto import SourceAppCreateDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + source_app_create_dto = '''{ + "name" : "my app", + "description" : "the source app for engineers", + "accountSource" : { + "name" : "ODS-AD-Source", + "id" : "2c9180827ca885d7017ca8ce28a000eb", + "type" : "SOURCE" + }, + "matchAllAccounts" : true + }''' # SourceAppCreateDto | + try: + # Create source app + new_source_app_create_dto = SourceAppCreateDto.from_json(source_app_create_dto) + results = AppsApi(api_client).create_source_app(x_sail_point_experimental=x_sail_point_experimental, source_app_create_dto=new_source_app_create_dto) + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).create_source_app(x_sail_point_experimental, new_source_app_create_dto) + print("The response of AppsApi->create_source_app:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AppsApi->create_source_app: %s\n" % e) /source-apps/all: get: operationId: listAllSourceApp @@ -85217,12 +109412,12 @@ paths: - ORG_ADMIN description: 'This API returns the list of all source apps for the org. ' parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - in: query name: sorters schema: @@ -85279,25 +109474,25 @@ paths: type: array items: $ref: '#/paths/~1source-apps~1%7Bid%7D/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/app/SourceApp.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/app/SourceApp.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/apps#list-all-source-app + label: SDK_tools/sdk/powershell/v2025/methods/apps#list-all-source-app source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $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) @@ -85309,14 +109504,42 @@ paths: # List all source apps try { - Get-V2024AllSourceApp -XSailPointExperimental $XSailPointExperimental + Get-V2025AllSourceApp -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024AllSourceApp -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters + # Get-V2025AllSourceApp -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AllSourceApp" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AllSourceApp" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/apps#list-all-source-app + source: | + from sailpoint.v2025.api.apps_api import AppsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.source_app import SourceApp + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + 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) + 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) + sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) + filters = 'enabled eq true' # 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: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* (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: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* (optional) + try: + # List all source apps + + results = AppsApi(api_client).list_all_source_app(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).list_all_source_app(x_sail_point_experimental, limit, count, offset, sorters, filters) + print("The response of AppsApi->list_all_source_app:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AppsApi->list_all_source_app: %s\n" % e) /source-apps/{id}/access-profiles: get: operationId: listAccessProfilesForSourceApp @@ -85336,10 +109559,10 @@ paths: schema: type: string example: 2c91808a7813090a017814121e121518 - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - in: query name: filters schema: @@ -85573,22 +109796,22 @@ paths: example: true '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/apps#list-access-profiles-for-source-app + label: SDK_tools/sdk/powershell/v2025/methods/apps#list-access-profiles-for-source-app source: | $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -85599,14 +109822,41 @@ paths: # List access profiles for the specified source app try { - Get-V2024AccessProfilesForSourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2025AccessProfilesForSourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024AccessProfilesForSourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $Filters + # Get-V2025AccessProfilesForSourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessProfilesForSourceApp" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessProfilesForSourceApp" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/apps#list-access-profiles-for-source-app + source: | + from sailpoint.v2025.api.apps_api import AppsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.access_profile_details import AccessProfileDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + filters = 'name eq \"developer access profile\"' # 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: **id**: *eq, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (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: **id**: *eq, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + try: + # List access profiles for the specified source app + + results = AppsApi(api_client).list_access_profiles_for_source_app(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).list_access_profiles_for_source_app(id, x_sail_point_experimental, limit, offset, filters) + print("The response of AppsApi->list_access_profiles_for_source_app:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AppsApi->list_access_profiles_for_source_app: %s\n" % e) /source-apps/{id}/access-profiles/bulk-remove: post: operationId: deleteAccessProfilesFromSourceAppByBulk @@ -85626,8 +109876,8 @@ paths: schema: type: string example: 2c91808a7813090a017814121e121518 - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - name: X-SailPoint-Experimental in: header description: Use this header to enable this experimental API. @@ -85657,25 +109907,25 @@ paths: type: array items: $ref: '#/paths/~1source-apps~1%7Bid%7D~1access-profiles/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/app/AccessProfileDetails.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/app/AccessProfileDetails.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/apps#delete-access-profiles-from-source-app-by-bulk + label: SDK_tools/sdk/powershell/v2025/methods/apps#delete-access-profiles-from-source-app-by-bulk source: | $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -85688,14 +109938,40 @@ paths: try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Remove-V2024AccessProfilesFromSourceAppByBulk -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + Remove-V2025AccessProfilesFromSourceAppByBulk -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result # Below is a request that includes all optional parameters - # Remove-V2024AccessProfilesFromSourceAppByBulk -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result -Limit $Limit + # Remove-V2025AccessProfilesFromSourceAppByBulk -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result -Limit $Limit } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessProfilesFromSourceAppByBulk" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025AccessProfilesFromSourceAppByBulk" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/apps#delete-access-profiles-from-source-app-by-bulk + source: | + from sailpoint.v2025.api.apps_api import AppsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.access_profile_details import AccessProfileDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + request_body = '''[c9575abb5e3a4e3db82b2f989a738aa2, c9dc28e148a24d65b3ccb5fb8ca5ddd9]''' # List[str] | + 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) + try: + # Bulk remove access profiles from the specified source app + new_request_body = RequestBody.from_json(request_body) + results = AppsApi(api_client).delete_access_profiles_from_source_app_by_bulk(id=id, x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).delete_access_profiles_from_source_app_by_bulk(id, x_sail_point_experimental, new_request_body, limit) + print("The response of AppsApi->delete_access_profiles_from_source_app_by_bulk:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AppsApi->delete_access_profiles_from_source_app_by_bulk: %s\n" % e) /user-apps/{id}: patch: operationId: patchUserApp @@ -85732,7 +110008,7 @@ paths: type: array items: $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/JsonPatchOperation.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/JsonPatchOperation.yaml example: - op: replace path: /account @@ -85847,25 +110123,25 @@ paths: example: John.Doe '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '404': $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/404.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/404.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/apps#patch-user-app + label: SDK_tools/sdk/powershell/v2025/methods/apps#patch-user-app source: | $Id = "2c91808a7813090a017814121e121518" # String | ID of the user app to patch $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -85879,14 +110155,40 @@ paths: # Patch user app by ID try { - Update-V2024UserApp -Id $Id -XSailPointExperimental $XSailPointExperimental + Update-V2025UserApp -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Update-V2024UserApp -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result + # Update-V2025UserApp -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024UserApp" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025UserApp" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/apps#patch-user-app + source: | + from sailpoint.v2025.api.apps_api import AppsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2025.models.user_app import UserApp + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121e121518' # str | ID of the user app to patch # str | ID of the user app to patch + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + json_patch_operation = '''[sailpoint.v2025.JsonPatchOperation()]''' # List[JsonPatchOperation] | (optional) + try: + # Patch user app by ID + + results = AppsApi(api_client).patch_user_app(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).patch_user_app(id, x_sail_point_experimental, new_json_patch_operation) + print("The response of AppsApi->patch_user_app:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AppsApi->patch_user_app: %s\n" % e) /user-apps/{id}/available-accounts: get: operationId: listAvailableAccountsForUserApp @@ -85906,10 +110208,10 @@ paths: schema: type: string example: 2c91808a7813090a017814121e121518 - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - name: X-SailPoint-Experimental in: header description: Use this header to enable this experimental API. @@ -85961,22 +110263,22 @@ paths: example: ODS-AD-SOURCE '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/apps#list-available-accounts-for-user-app + label: SDK_tools/sdk/powershell/v2025/methods/apps#list-available-accounts-for-user-app source: | $Id = "2c91808a7813090a017814121e121518" # String | ID of the user app $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -85986,14 +110288,40 @@ paths: # List available accounts for user app try { - Get-V2024AvailableAccountsForUserApp -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2025AvailableAccountsForUserApp -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024AvailableAccountsForUserApp -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count + # Get-V2025AvailableAccountsForUserApp -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AvailableAccountsForUserApp" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AvailableAccountsForUserApp" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/apps#list-available-accounts-for-user-app + source: | + from sailpoint.v2025.api.apps_api import AppsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.app_account_details import AppAccountDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121e121518' # str | ID of the user app # str | ID of the user app + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + 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 available accounts for user app + + results = AppsApi(api_client).list_available_accounts_for_user_app(id=id, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).list_available_accounts_for_user_app(id, x_sail_point_experimental, limit, count) + print("The response of AppsApi->list_available_accounts_for_user_app:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AppsApi->list_available_accounts_for_user_app: %s\n" % e) /user-apps: get: operationId: listOwnedUserApps @@ -86005,12 +110333,12 @@ paths: - idn:app-roles:read description: This API returns the list of user apps assigned to logged in user parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - in: query name: filters schema: @@ -86050,25 +110378,25 @@ paths: type: array items: $ref: '#/paths/~1user-apps~1%7Bid%7D/patch/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/app/UserApp.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/app/UserApp.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/apps#list-owned-user-apps + label: SDK_tools/sdk/powershell/v2025/methods/apps#list-owned-user-apps source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $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) @@ -86079,14 +110407,41 @@ paths: # List owned user apps try { - Get-V2024OwnedUserApps -XSailPointExperimental $XSailPointExperimental + Get-V2025OwnedUserApps -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024OwnedUserApps -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Filters $Filters + # Get-V2025OwnedUserApps -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OwnedUserApps" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025OwnedUserApps" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/apps#list-owned-user-apps + source: | + from sailpoint.v2025.api.apps_api import AppsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.user_app import UserApp + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + 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) + 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) + filters = 'name eq \"user app name\"' # 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: **id**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* (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: **id**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* (optional) + try: + # List owned user apps + + results = AppsApi(api_client).list_owned_user_apps(x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).list_owned_user_apps(x_sail_point_experimental, limit, count, offset, filters) + print("The response of AppsApi->list_owned_user_apps:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AppsApi->list_owned_user_apps: %s\n" % e) /user-apps/all: get: operationId: listAllUserApps @@ -86100,12 +110455,12 @@ paths: This API returns the list of all user apps with specified filters. This API must be used with **filters** query parameter. parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/limit.yaml + - $ref: '#/paths/~1access-profiles/get/parameters/1' + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/limit.yaml - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/offset.yaml - in: query name: filters schema: @@ -86147,25 +110502,25 @@ paths: type: array items: $ref: '#/paths/~1user-apps~1%7Bid%7D/patch/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/app/UserApp.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/app/UserApp.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/apps#list-all-user-apps + label: SDK_tools/sdk/powershell/v2025/methods/apps#list-all-user-apps source: | $Filters = "name eq "user app name"" # 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: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") @@ -86176,14 +110531,41 @@ paths: # List all user apps try { - Get-V2024AllUserApps -Filters $Filters -XSailPointExperimental $XSailPointExperimental + Get-V2025AllUserApps -Filters $Filters -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024AllUserApps -Filters $Filters -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset + # Get-V2025AllUserApps -Filters $Filters -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AllUserApps" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AllUserApps" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/apps#list-all-user-apps + source: | + from sailpoint.v2025.api.apps_api import AppsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.user_app import UserApp + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = true + + with ApiClient(configuration) as api_client: + filters = 'name eq \"user app name\"' # 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: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* # 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: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + 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) + 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) + 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) + try: + # List all user apps + + results = AppsApi(api_client).list_all_user_apps(filters=filters, x_sail_point_experimental=x_sail_point_experimental) + # Below is a request that includes all optional parameters + # results = AppsApi(api_client).list_all_user_apps(filters, x_sail_point_experimental, limit, count, offset) + print("The response of AppsApi->list_all_user_apps:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AppsApi->list_all_user_apps: %s\n" % e) /roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}: post: operationId: updateAttributeKeyAndValueToRole @@ -86228,25 +110610,25 @@ paths: application/json: schema: $ref: '#/paths/~1roles/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/access/Role.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/access/Role.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/roles#update-attribute-key-and-value-to-role + label: SDK_tools/sdk/powershell/v2025/methods/roles#update-attribute-key-and-value-to-role source: | $Id = "c24359c389374d0fb8585698a2189e3d" # String | The Id of a role $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. @@ -86255,14 +110637,38 @@ paths: # Add a Metadata to Role. try { - Update-V2024AttributeKeyAndValueToRole -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue + Update-V2025AttributeKeyAndValueToRole -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue # Below is a request that includes all optional parameters - # Update-V2024AttributeKeyAndValueToRole -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue + # Update-V2025AttributeKeyAndValueToRole -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AttributeKeyAndValueToRole" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AttributeKeyAndValueToRole" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/roles#update-attribute-key-and-value-to-role + source: | + from sailpoint.v2025.api.roles_api import RolesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.role import Role + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c24359c389374d0fb8585698a2189e3d' # str | The Id of a role # str | The Id of a role + attribute_key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. + attribute_value = 'public' # str | Technical name of the Attribute Value. # str | Technical name of the Attribute Value. + try: + # Add a Metadata to Role. + + results = RolesApi(api_client).update_attribute_key_and_value_to_role(id=id, attribute_key=attribute_key, attribute_value=attribute_value) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).update_attribute_key_and_value_to_role(id, attribute_key, attribute_value) + print("The response of RolesApi->update_attribute_key_and_value_to_role:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RolesApi->update_attribute_key_and_value_to_role: %s\n" % e) delete: operationId: deleteMetadataFromRoleByKeyAndValue summary: Remove a Metadata From Role. @@ -86306,22 +110712,22 @@ paths: description: Request accepted '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/roles#delete-metadata-from-role-by-key-and-value + label: SDK_tools/sdk/powershell/v2025/methods/roles#delete-metadata-from-role-by-key-and-value source: | $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The role's id. $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. @@ -86330,14 +110736,35 @@ paths: # Remove a Metadata From Role. try { - Remove-V2024MetadataFromRoleByKeyAndValue -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue + Remove-V2025MetadataFromRoleByKeyAndValue -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue # Below is a request that includes all optional parameters - # Remove-V2024MetadataFromRoleByKeyAndValue -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue + # Remove-V2025MetadataFromRoleByKeyAndValue -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024MetadataFromRoleByKeyAndValue" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025MetadataFromRoleByKeyAndValue" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/roles#delete-metadata-from-role-by-key-and-value + source: | + from sailpoint.v2025.api.roles_api import RolesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c91808c74ff913f0175097daa9d59cd' # str | The role's id. # str | The role's id. + attribute_key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. + attribute_value = 'public' # str | Technical name of the Attribute Value. # str | Technical name of the Attribute Value. + try: + # Remove a Metadata From Role. + + RolesApi(api_client).delete_metadata_from_role_by_key_and_value(id=id, attribute_key=attribute_key, attribute_value=attribute_value) + # Below is a request that includes all optional parameters + # RolesApi(api_client).delete_metadata_from_role_by_key_and_value(id, attribute_key, attribute_value) + except Exception as e: + print("Exception when calling RolesApi->delete_metadata_from_role_by_key_and_value: %s\n" % e) /roles/access-model-metadata/bulk-update/ids: post: operationId: updateRolesMetadataByIds @@ -86449,22 +110876,22 @@ paths: example: '2020-10-08T18:33:52.029Z' '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/roles#update-roles-metadata-by-ids + label: SDK_tools/sdk/powershell/v2025/methods/roles#update-roles-metadata-by-ids source: | $RoleMetadataBulkUpdateByIdRequest = @" { @@ -86482,14 +110909,45 @@ paths: try { $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByIdRequest -Json $RoleMetadataBulkUpdateByIdRequest - Update-V2024RolesMetadataByIds -RoleMetadataBulkUpdateByIdRequest $Result + Update-V2025RolesMetadataByIds -RoleMetadataBulkUpdateByIdRequest $Result # Below is a request that includes all optional parameters - # Update-V2024RolesMetadataByIds -RoleMetadataBulkUpdateByIdRequest $Result + # Update-V2025RolesMetadataByIds -RoleMetadataBulkUpdateByIdRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByIds" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025RolesMetadataByIds" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/roles#update-roles-metadata-by-ids + source: | + from sailpoint.v2025.api.roles_api import RolesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.role_bulk_update_response import RoleBulkUpdateResponse + from sailpoint.v2025.models.role_metadata_bulk_update_by_id_request import RoleMetadataBulkUpdateByIdRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + role_metadata_bulk_update_by_id_request = '''{ + "roles" : [ "b1db89554cfa431cb8b9921ea38d9367" ], + "values" : [ { + "attribute" : "iscFederalClassifications", + "values" : [ "topSecret" ] + } ], + "replaceScope" : "ALL", + "operation" : "REPLACE" + }''' # RoleMetadataBulkUpdateByIdRequest | + try: + # Bulk-Update Roles' Metadata by ID + new_role_metadata_bulk_update_by_id_request = RoleMetadataBulkUpdateByIdRequest.from_json(role_metadata_bulk_update_by_id_request) + results = RolesApi(api_client).update_roles_metadata_by_ids(role_metadata_bulk_update_by_id_request=new_role_metadata_bulk_update_by_id_request) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).update_roles_metadata_by_ids(new_role_metadata_bulk_update_by_id_request) + print("The response of RolesApi->update_roles_metadata_by_ids:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RolesApi->update_roles_metadata_by_ids: %s\n" % e) /roles/access-model-metadata/bulk-update/filter: post: operationId: updateRolesMetadataByFilter @@ -86591,7 +111049,7 @@ paths: application/json: schema: $ref: '#/paths/~1roles~1access-model-metadata~1bulk-update~1ids/post/responses/202/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/role-metadata/RoleBulkUpdateResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/role-metadata/RoleBulkUpdateResponse.yaml examples: Update request created successfully: value: @@ -86601,22 +111059,22 @@ paths: created: '2024-09-16T18:59:06.871Z' '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/roles#update-roles-metadata-by-filter + label: SDK_tools/sdk/powershell/v2025/methods/roles#update-roles-metadata-by-filter source: | $RoleMetadataBulkUpdateByFilterRequest = @" { @@ -86634,14 +111092,45 @@ paths: try { $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByFilterRequest -Json $RoleMetadataBulkUpdateByFilterRequest - Update-V2024RolesMetadataByFilter -RoleMetadataBulkUpdateByFilterRequest $Result + Update-V2025RolesMetadataByFilter -RoleMetadataBulkUpdateByFilterRequest $Result # Below is a request that includes all optional parameters - # Update-V2024RolesMetadataByFilter -RoleMetadataBulkUpdateByFilterRequest $Result + # Update-V2025RolesMetadataByFilter -RoleMetadataBulkUpdateByFilterRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByFilter" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025RolesMetadataByFilter" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/roles#update-roles-metadata-by-filter + source: | + from sailpoint.v2025.api.roles_api import RolesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.role_bulk_update_response import RoleBulkUpdateResponse + from sailpoint.v2025.models.role_metadata_bulk_update_by_filter_request import RoleMetadataBulkUpdateByFilterRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + role_metadata_bulk_update_by_filter_request = '''{ + "values" : [ { + "attribute" : "iscFederalClassifications", + "values" : [ "topSecret" ] + } ], + "filters" : " requestable eq false", + "replaceScope" : "ALL", + "operation" : "REPLACE" + }''' # RoleMetadataBulkUpdateByFilterRequest | + try: + # Bulk-Update Roles' Metadata by Filters + new_role_metadata_bulk_update_by_filter_request = RoleMetadataBulkUpdateByFilterRequest.from_json(role_metadata_bulk_update_by_filter_request) + results = RolesApi(api_client).update_roles_metadata_by_filter(role_metadata_bulk_update_by_filter_request=new_role_metadata_bulk_update_by_filter_request) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).update_roles_metadata_by_filter(new_role_metadata_bulk_update_by_filter_request) + print("The response of RolesApi->update_roles_metadata_by_filter:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RolesApi->update_roles_metadata_by_filter: %s\n" % e) /roles/access-model-metadata/bulk-update/query: post: operationId: updateRolesMetadataByQuery @@ -86672,7 +111161,7 @@ paths: type: object items: $ref: '#/components/schemas/RoleMetadataBulkUpdateByQueryRequest/properties/query/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/Search.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/Search.yaml example: query": indices: @@ -86754,7 +111243,7 @@ paths: application/json: schema: $ref: '#/paths/~1roles~1access-model-metadata~1bulk-update~1ids/post/responses/202/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/role-metadata/RoleBulkUpdateResponse.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/role-metadata/RoleBulkUpdateResponse.yaml examples: Update request created successfully: value: @@ -86764,22 +111253,22 @@ paths: created: '2024-09-16T18:59:06.871594Z' '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/roles#update-roles-metadata-by-query + label: SDK_tools/sdk/powershell/v2025/methods/roles#update-roles-metadata-by-query source: | $RoleMetadataBulkUpdateByQueryRequest = @" { @@ -86812,14 +111301,60 @@ paths: try { $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByQueryRequest -Json $RoleMetadataBulkUpdateByQueryRequest - Update-V2024RolesMetadataByQuery -RoleMetadataBulkUpdateByQueryRequest $Result + Update-V2025RolesMetadataByQuery -RoleMetadataBulkUpdateByQueryRequest $Result # Below is a request that includes all optional parameters - # Update-V2024RolesMetadataByQuery -RoleMetadataBulkUpdateByQueryRequest $Result + # Update-V2025RolesMetadataByQuery -RoleMetadataBulkUpdateByQueryRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByQuery" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025RolesMetadataByQuery" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/roles#update-roles-metadata-by-query + source: | + from sailpoint.v2025.api.roles_api import RolesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.role_bulk_update_response import RoleBulkUpdateResponse + from sailpoint.v2025.models.role_metadata_bulk_update_by_query_request import RoleMetadataBulkUpdateByQueryRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + role_metadata_bulk_update_by_query_request = '''{ + "query" : { + "query\"" : { + "indices" : [ "roles" ], + "queryType" : "TEXT", + "textQuery" : { + "terms" : [ "test123" ], + "fields" : [ "id" ], + "matchAny" : false, + "contains" : true + }, + "includeNested" : false + } + }, + "values" : [ { + "attributeValue" : [ "topSecret" ], + "attributeKey" : "iscFederalClassifications" + }, { + "attributeValue" : [ "topSecret" ], + "attributeKey" : "iscFederalClassifications" + } ], + "replaceScope" : "ALL", + "operation" : "REPLACE" + }''' # RoleMetadataBulkUpdateByQueryRequest | + try: + # Bulk-Update Roles' Metadata by Query + new_role_metadata_bulk_update_by_query_request = RoleMetadataBulkUpdateByQueryRequest.from_json(role_metadata_bulk_update_by_query_request) + results = RolesApi(api_client).update_roles_metadata_by_query(role_metadata_bulk_update_by_query_request=new_role_metadata_bulk_update_by_query_request) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).update_roles_metadata_by_query(new_role_metadata_bulk_update_by_query_request) + print("The response of RolesApi->update_roles_metadata_by_query:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RolesApi->update_roles_metadata_by_query: %s\n" % e) /roles/access-model-metadata/bulk-update/id: get: operationId: getBulkUpdateStatusById @@ -86848,8 +111383,33 @@ paths: content: application/json: schema: - $ref: '#/paths/~1roles~1access-model-metadata~1bulk-update~1ids/post/responses/202/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/role-metadata/RoleBulkUpdateResponse.yaml + type: object + properties: + id: + type: string + description: ID of the task which is executing the bulk update. This also used in to the bulk-update/** API to track status. + example: 2c9180867817ac4d017817c491119a20 + type: + type: string + description: Type of the bulk update object. + example: Role + status: + type: string + description: The status of the bulk update request, could also checked by getBulkUpdateStatus API + enum: + - CREATED + - PRE_PROCESS + - PRE_PROCESS_COMPLETED + - POST_PROCESS + - COMPLETED + - CHUNK_PENDING + - CHUNK_PROCESSING + example: CREATED + created: + type: string + description: Time when the bulk update request was created + format: date-time + example: '2020-10-08T18:33:52.029Z' examples: Update request created successfully: value: @@ -86859,36 +111419,58 @@ paths: created: '2024-09-16T18:59:06.871594Z' '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/roles#get-bulk-update-status-by-id + label: SDK_tools/sdk/powershell/v2025/methods/roles#get-bulk-update-status-by-id source: | $Id = "c24359c389374d0fb8585698a2189e3d" # String | The Id of the bulk update task. # Get Bulk-Update Status by ID try { - Get-V2024BulkUpdateStatusById -Id $Id + Get-V2025BulkUpdateStatusById -Id $Id # Below is a request that includes all optional parameters - # Get-V2024BulkUpdateStatusById -Id $Id + # Get-V2025BulkUpdateStatusById -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024BulkUpdateStatusById" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025BulkUpdateStatusById" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/roles#get-bulk-update-status-by-id + source: | + from sailpoint.v2025.api.roles_api import RolesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.role_bulk_update_response import RoleBulkUpdateResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c24359c389374d0fb8585698a2189e3d' # str | The Id of the bulk update task. # str | The Id of the bulk update task. + try: + # Get Bulk-Update Status by ID + + results = RolesApi(api_client).get_bulk_update_status_by_id(id=id) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).get_bulk_update_status_by_id(id) + print("The response of RolesApi->get_bulk_update_status_by_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RolesApi->get_bulk_update_status_by_id: %s\n" % e) /roles/access-model-metadata/bulk-update: get: operationId: getBulkUpdateStatus @@ -86939,35 +111521,56 @@ paths: example: '2020-10-08T18:33:52.029Z' '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/roles#get-bulk-update-status + label: SDK_tools/sdk/powershell/v2025/methods/roles#get-bulk-update-status source: | # Get Bulk-Update Statuses try { - Get-V2024BulkUpdateStatus + Get-V2025BulkUpdateStatus # Below is a request that includes all optional parameters - # Get-V2024BulkUpdateStatus + # Get-V2025BulkUpdateStatus } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024BulkUpdateStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025BulkUpdateStatus" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/roles#get-bulk-update-status + source: | + from sailpoint.v2025.api.roles_api import RolesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.role_get_all_bulk_update_response import RoleGetAllBulkUpdateResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get Bulk-Update Statuses + + results = RolesApi(api_client).get_bulk_update_status() + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).get_bulk_update_status() + print("The response of RolesApi->get_bulk_update_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RolesApi->get_bulk_update_status: %s\n" % e) /roles/filter: post: operationId: searchRolesByFilter @@ -87050,7 +111653,7 @@ paths: required: false example: false - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/count.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/parameters/count.yaml requestBody: content: application/json: @@ -87114,25 +111717,25 @@ paths: type: array allOf: - $ref: '#/paths/~1roles/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/access/Role.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/access/Role.yaml '400': $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/400.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/400.yaml '401': $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/401.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/401.yaml '403': $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/403.yaml '429': $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/429.yaml '500': $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/responses/500.yaml x-codeSamples: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/roles#search-roles-by-filter + label: SDK_tools/sdk/powershell/v2025/methods/roles#search-roles-by-filter source: | $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) $Limit = 50 # 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 50) @@ -87154,14 +111757,50 @@ paths: # Filter Roles by Metadata try { - Search-V2024RolesByFilter + Search-V2025RolesByFilter # Below is a request that includes all optional parameters - # Search-V2024RolesByFilter -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -RoleListFilterDTO $Result + # Search-V2025RolesByFilter -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -RoleListFilterDTO $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024RolesByFilter" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2025RolesByFilter" Write-Host $_.ErrorDetails } + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/roles#search-roles-by-filter + source: | + from sailpoint.v2025.api.roles_api import RolesApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.role import Role + from sailpoint.v2025.models.role_list_filter_dto import RoleListFilterDTO + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + for_subadmin = '5168015d32f890ca15812c9180835d2e' # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + limit = 50 # 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 50) # 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 50) + 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) + sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + include_unsegmented = True # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) + role_list_filter_dto = '''{ + "ammKeyValues" : [ { + "attribute" : "iscFederalClassifications", + "values" : [ "secret" ] + } ], + "filters" : "dimensional eq false" + }''' # RoleListFilterDTO | (optional) + try: + # Filter Roles by Metadata + + results = RolesApi(api_client).search_roles_by_filter() + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).search_roles_by_filter(for_subadmin, limit, offset, count, sorters, for_segment_ids, include_unsegmented, new_role_list_filter_dto) + print("The response of RolesApi->search_roles_by_filter:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RolesApi->search_roles_by_filter: %s\n" % e) security: - userAuth: - sp:scopes:all @@ -87537,7 +112176,7 @@ components: allOf: - allOf: - $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/owner' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/DisplayReference.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/DisplayReference.yaml - type: object properties: description: @@ -87565,7 +112204,7 @@ components: owner: allOf: - $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/Reference.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Reference.yaml - type: object properties: displayName: @@ -87624,6 +112263,7 @@ components: description: Name of the Object type: string example: aName + nullable: true created: description: Creation date of the Object type: string @@ -87763,6 +112403,7 @@ components: example: true identity: description: The identity this account is correlated to + type: object properties: id: type: string @@ -87946,7 +112587,7 @@ components: default: false targetIdentitySummary: $ref: '#/components/schemas/AccountActivity/properties/requesterIdentitySummary' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/IdentitySummary.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/IdentitySummary.yaml errors: nullable: true description: A list of error messages, if any, that were encountered. @@ -88030,10 +112671,10 @@ components: example: '2017-07-11T18:45:37.098Z' reviewerIdentitySummary: $ref: '#/components/schemas/AccountActivity/properties/requesterIdentitySummary' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/IdentitySummary.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/IdentitySummary.yaml reviewerComment: $ref: '#/components/schemas/AccountActivity/properties/items/items/properties/requesterComment' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/Comment.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Comment.yaml operation: type: string nullable: true @@ -88084,7 +112725,7 @@ components: example: Treasury Analyst requestedObjectType: $ref: '#/components/schemas/RequestableObject/properties/type' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/RequestableObjectType.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/RequestableObjectType.yaml description: If an account activity item is associated with an access request, captures details of that request. clientMetadata: nullable: true @@ -88164,7 +112805,7 @@ components: requester: allOf: - $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/Reference.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Reference.yaml - type: object properties: type: @@ -88173,7 +112814,7 @@ components: description: Type of object recipient: $ref: '#/components/schemas/AccountActivitySearchedItem/properties/requester' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/account/ActivityIdentity.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/account/ActivityIdentity.yaml trackingNumber: type: string description: Account activity's tracking number. @@ -88213,13 +112854,13 @@ components: example: Automated AR Approval date: $ref: '#/components/schemas/Schedule/properties/expiration' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/DateTime.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/DateTime.yaml modified: $ref: '#/components/schemas/Schedule/properties/expiration' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/DateTime.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/DateTime.yaml owner: $ref: '#/components/schemas/AccountActivitySearchedItem/properties/requester' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/account/ActivityIdentity.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/account/ActivityIdentity.yaml result: type: string description: The result of the approval @@ -88249,7 +112890,7 @@ components: source: allOf: - $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/Reference.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Reference.yaml - type: object properties: type: @@ -88278,14 +112919,14 @@ components: description: Attribute changes requested for account. items: $ref: '#/components/schemas/AccountActivitySearchedItem/properties/approvals/items/properties/attributeRequest' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/account/activity/AttributeRequest.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/account/activity/AttributeRequest.yaml op: type: string description: Operation used. example: add source: $ref: '#/components/schemas/AccountActivitySearchedItem/properties/approvals/items/properties/source' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/account/AccountSource.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/account/AccountSource.yaml expansionItems: type: array description: Controls that translated the attribute requests into actual provisioning actions on the source. @@ -88306,10 +112947,10 @@ components: example: smartsheet-role attributeRequest: $ref: '#/components/schemas/AccountActivitySearchedItem/properties/approvals/items/properties/attributeRequest' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/account/activity/AttributeRequest.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/account/activity/AttributeRequest.yaml source: $ref: '#/components/schemas/AccountActivitySearchedItem/properties/approvals/items/properties/source' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/account/AccountSource.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/account/AccountSource.yaml id: type: string description: ID of the expansion item @@ -88332,14 +112973,14 @@ components: type: array items: $ref: '#/components/schemas/AccountActivitySearchedItem/properties/approvals/items/properties/attributeRequest' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/account/activity/AttributeRequest.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/account/activity/AttributeRequest.yaml op: type: string example: Modify description: The operation that was performed provisioningTarget: $ref: '#/components/schemas/AccountActivitySearchedItem/properties/approvals/items/properties/source' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/account/AccountSource.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/account/AccountSource.yaml result: type: object properties: @@ -88370,7 +113011,7 @@ components: description: ID of associated ticket. source: $ref: '#/components/schemas/AccountActivitySearchedItem/properties/approvals/items/properties/source' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/account/AccountSource.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/account/AccountSource.yaml sources: type: string description: Sources involved in the account activity. @@ -88675,7 +113316,7 @@ components: properties: from: $ref: '#/components/schemas/Reassignment/properties/from' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/CertificationReference.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/CertificationReference.yaml comment: type: string description: The comment entered when the Certification was reassigned @@ -88719,7 +113360,7 @@ components: example: CERTIFICATION reviewer: $ref: '#/components/schemas/Certification/properties/reviewer' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/Reviewer.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Reviewer.yaml EntitlementDocument: description: Entitlement allOf: @@ -88775,7 +113416,7 @@ components: description: Segments with the entitlement. items: $ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/segments/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/BaseSegment.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/BaseSegment.yaml segmentCount: type: integer description: Number of segments with the role. @@ -88804,7 +113445,7 @@ components: example: false tags: $ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/tags' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/Tags.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Tags.yaml attribute: type: string description: Attribute information for the entitlement. @@ -88870,12 +113511,12 @@ components: description: EntitlementReference allOf: - $ref: '#/components/schemas/AccessProfileSummary/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/access/Access.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/access/Access.yaml - type: object properties: source: $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/Reference.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Reference.yaml type: type: string description: Type of the access item. @@ -88985,9 +113626,9 @@ components: description: Identity allOf: - $ref: '#/components/schemas/EntitlementDocument/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/BaseDocument.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/BaseDocument.yaml - $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/owner' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/DisplayReference.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/DisplayReference.yaml - type: object properties: displayName: @@ -89119,7 +113760,7 @@ components: properties: date: $ref: '#/components/schemas/Schedule/properties/expiration' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/DateTime.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/DateTime.yaml stage: type: string example: In Process @@ -89139,7 +113780,7 @@ components: items: allOf: - $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/Reference.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Reference.yaml - type: object properties: accountId: @@ -89148,7 +113789,7 @@ components: example: John.Doe source: $ref: '#/components/schemas/AccountActivitySearchedItem/properties/approvals/items/properties/source' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/account/AccountSource.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/account/AccountSource.yaml disabled: type: boolean description: Indicates whether the account is disabled. @@ -89171,7 +113812,7 @@ components: example: false passwordLastSet: $ref: '#/components/schemas/Schedule/properties/expiration' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/DateTime.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/DateTime.yaml entitlementAttributes: type: object nullable: true @@ -89212,12 +113853,12 @@ components: items: allOf: - $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/Reference.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Reference.yaml - type: object properties: source: $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/Reference.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Reference.yaml account: type: object properties: @@ -89248,7 +113889,7 @@ components: - description: This is a summary representation of an access profile. allOf: - $ref: '#/components/schemas/AccessProfileSummary/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/access/Access.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/access/Access.yaml - type: object properties: type: @@ -89257,22 +113898,22 @@ components: example: ACCESS_PROFILE source: $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/Reference.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Reference.yaml owner: $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/owner' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/DisplayReference.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/DisplayReference.yaml revocable: type: boolean example: true - description: EntitlementReference allOf: - $ref: '#/components/schemas/AccessProfileSummary/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/access/Access.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/access/Access.yaml - type: object properties: source: $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/Reference.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Reference.yaml type: type: string description: Type of the access item. @@ -89292,7 +113933,7 @@ components: - description: Role allOf: - $ref: '#/components/schemas/AccessProfileSummary/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/access/Access.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/access/Access.yaml - type: object properties: type: @@ -89301,7 +113942,7 @@ components: example: ROLE owner: $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/owner' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/DisplayReference.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/DisplayReference.yaml disabled: type: boolean revocable: @@ -89336,32 +113977,32 @@ components: type: array items: $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/Reference.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Reference.yaml entitlements: type: array items: $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/Reference.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Reference.yaml accessProfiles: type: array items: $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/Reference.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Reference.yaml roles: type: array items: $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/Reference.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Reference.yaml apps: type: array items: $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/Reference.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Reference.yaml governanceGroups: type: array items: $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/source' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/Reference.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Reference.yaml fallbackApprover: type: boolean example: false @@ -89372,7 +114013,7 @@ components: example: 5 tags: $ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/tags' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/Tags.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Tags.yaml tagsCount: type: integer format: int32 @@ -89393,7 +114034,7 @@ components: IdentityProfile: allOf: - $ref: '#/components/schemas/Account/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/BaseCommonDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BaseCommonDto.yaml - type: object required: - authoritativeSource @@ -89524,6 +114165,7 @@ components: example: Alison Ferguso email: type: string + nullable: true description: Identity's email address. This is read-only. example: alison.ferguso@identitysoon.com ProvisioningConfig: @@ -89705,7 +114347,7 @@ components: example: CERTIFICATION reviewer: $ref: '#/components/schemas/Certification/properties/reviewer' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/Reviewer.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/Reviewer.yaml comment: type: string description: The comment entered when the Certification was reassigned @@ -89800,7 +114442,7 @@ components: - ACCESS_PROFILE - ROLE - ENTITLEMENT - description: 'The currently supported requestable object types. ' + description: Currently supported requestable object types. example: ACCESS_PROFILE requestStatus: allOf: @@ -89836,6 +114478,7 @@ components: example: Alison Ferguso email: type: string + nullable: true description: Identity's email address. This is read-only. example: alison.ferguso@identitysoon.com requestCommentsRequired: @@ -89848,7 +114491,7 @@ components: - ACCESS_PROFILE - ROLE - ENTITLEMENT - description: 'The currently supported requestable object types. ' + description: Currently supported requestable object types. example: ACCESS_PROFILE RequestableObjectRequestStatus: type: string @@ -89896,7 +114539,7 @@ components: description: Role allOf: - $ref: '#/components/schemas/AccessProfileDocument/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/access/BaseAccess.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/access/BaseAccess.yaml - type: object required: - id @@ -89933,14 +114576,14 @@ components: example: 1 tags: $ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/tags' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/Tags.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Tags.yaml segments: type: array description: Segments with the role. nullable: true items: $ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/segments/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/BaseSegment.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/BaseSegment.yaml segmentCount: type: integer description: Number of segments with the role. @@ -89954,7 +114597,7 @@ components: items: allOf: - $ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/entitlements/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/entitlement/BaseEntitlement.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/entitlement/BaseEntitlement.yaml - properties: sourceSchemaObjectType: type: string @@ -90025,7 +114668,7 @@ components: items: allOf: - $ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/entitlements/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/entitlement/BaseEntitlement.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/entitlement/BaseEntitlement.yaml - properties: sourceSchemaObjectType: type: string @@ -90041,12 +114684,12 @@ components: description: Access profiles included in the dimension. items: $ref: '#/components/schemas/RoleDocument/allOf/1/properties/accessProfiles/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/BaseAccessProfile.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/BaseAccessProfile.yaml RoleSummary: description: Role allOf: - $ref: '#/components/schemas/AccessProfileSummary/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/access/Access.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/access/Access.yaml - type: object properties: type: @@ -90055,7 +114698,7 @@ components: example: ROLE owner: $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/owner' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/DisplayReference.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/DisplayReference.yaml disabled: type: boolean revocable: @@ -90066,7 +114709,7 @@ components: - description: 'More complete representation of an access profile. ' allOf: - $ref: '#/components/schemas/AccessProfileDocument/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/access/BaseAccess.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/access/BaseAccess.yaml - type: object required: - id @@ -90097,7 +114740,7 @@ components: description: Entitlements the access profile has access to. items: $ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/entitlements/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/entitlement/BaseEntitlement.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/entitlement/BaseEntitlement.yaml entitlementCount: type: integer description: Number of entitlements. @@ -90107,7 +114750,7 @@ components: description: Segments with the access profile. items: $ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/segments/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/BaseSegment.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/BaseSegment.yaml segmentCount: type: integer description: Number of segments with the access profile. @@ -90115,13 +114758,13 @@ components: example: 1 tags: $ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/tags' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/Tags.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Tags.yaml apps: type: array description: Applications with the access profile items: $ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/apps/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/access/AccessApps.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/access/AccessApps.yaml - description: AccountActivity type: object properties: @@ -90165,10 +114808,10 @@ components: example: Complete requester: $ref: '#/components/schemas/AccountActivitySearchedItem/properties/requester' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/account/ActivityIdentity.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/account/ActivityIdentity.yaml recipient: $ref: '#/components/schemas/AccountActivitySearchedItem/properties/requester' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/account/ActivityIdentity.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/account/ActivityIdentity.yaml trackingNumber: type: string description: Account activity's tracking number. @@ -90192,25 +114835,25 @@ components: description: Approvals performed on an item during activity. items: $ref: '#/components/schemas/AccountActivitySearchedItem/properties/approvals/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/account/activity/Approval.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/account/activity/Approval.yaml originalRequests: type: array description: Original actions that triggered all individual source actions related to the account action. items: $ref: '#/components/schemas/AccountActivitySearchedItem/properties/originalRequests/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/account/activity/OriginalRequest.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/account/activity/OriginalRequest.yaml expansionItems: type: array description: Controls that translated the attribute requests into actual provisioning actions on the source. items: $ref: '#/components/schemas/AccountActivitySearchedItem/properties/expansionItems/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/account/activity/ExpansionItem.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/account/activity/ExpansionItem.yaml accountRequests: type: array description: Account data for each individual source action triggered by the original requests. items: $ref: '#/components/schemas/AccountActivitySearchedItem/properties/accountRequests/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/account/activity/AccountRequest.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/account/activity/AccountRequest.yaml sources: type: string description: Sources involved in the account activity. @@ -90218,7 +114861,7 @@ components: - description: Entitlement allOf: - $ref: '#/components/schemas/EntitlementDocument/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/BaseDocument.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/BaseDocument.yaml - type: object properties: modified: @@ -90258,7 +114901,7 @@ components: description: Segments with the entitlement. items: $ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/segments/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/BaseSegment.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/BaseSegment.yaml segmentCount: type: integer description: Number of segments with the role. @@ -90287,7 +114930,7 @@ components: example: false tags: $ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/tags' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/Tags.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Tags.yaml attribute: type: string description: Attribute information for the entitlement. @@ -90440,9 +115083,9 @@ components: - description: Identity allOf: - $ref: '#/components/schemas/EntitlementDocument/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/BaseDocument.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/BaseDocument.yaml - $ref: '#/components/schemas/AccessProfileSummary/allOf/1/properties/owner' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/DisplayReference.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/DisplayReference.yaml - type: object properties: displayName: @@ -90573,13 +115216,13 @@ components: $ref: '#/components/schemas/IdentityDocument/allOf/2/properties/processingDetails' description: Identity's processing details. nullable: true - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/identity/ProcessingDetails.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/identity/ProcessingDetails.yaml accounts: type: array description: List of accounts associated with the identity. items: $ref: '#/components/schemas/IdentityDocument/allOf/2/properties/accounts/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/account/BaseAccount.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/account/BaseAccount.yaml accountCount: type: integer description: Number of accounts associated with the identity. @@ -90590,7 +115233,7 @@ components: description: List of applications the identity has access to. items: $ref: '#/components/schemas/IdentityDocument/allOf/2/properties/apps/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/identity/App.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/identity/App.yaml appCount: type: integer format: int32 @@ -90601,7 +115244,7 @@ components: description: List of access items assigned to the identity. items: $ref: '#/components/schemas/IdentityDocument/allOf/2/properties/access/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/identity/IdentityAccess.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/identity/IdentityAccess.yaml accessCount: type: integer format: int32 @@ -90627,7 +115270,7 @@ components: description: Access items the identity owns. items: $ref: '#/components/schemas/IdentityDocument/allOf/2/properties/owns/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/identity/Owns.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/identity/Owns.yaml ownsCount: type: integer format: int32 @@ -90635,7 +115278,7 @@ components: example: 5 tags: $ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/tags' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/Tags.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Tags.yaml tagsCount: type: integer format: int32 @@ -90656,7 +115299,7 @@ components: - description: Role allOf: - $ref: '#/components/schemas/AccessProfileDocument/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/access/BaseAccess.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/access/BaseAccess.yaml - type: object required: - id @@ -90676,7 +115319,7 @@ components: nullable: true items: $ref: '#/components/schemas/RoleDocument/allOf/1/properties/accessProfiles/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/BaseAccessProfile.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/BaseAccessProfile.yaml accessProfileCount: type: integer description: Number of access profiles included with the role. @@ -90686,14 +115329,14 @@ components: tags: $ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/tags' nullable: true - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/Tags.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/Tags.yaml segments: type: array description: Segments with the role. nullable: true items: $ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/segments/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/BaseSegment.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/BaseSegment.yaml segmentCount: type: integer description: Number of segments with the role. @@ -90707,7 +115350,7 @@ components: items: allOf: - $ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/entitlements/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/entitlement/BaseEntitlement.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/entitlement/BaseEntitlement.yaml - properties: sourceSchemaObjectType: type: string @@ -90778,7 +115421,7 @@ components: items: allOf: - $ref: '#/components/schemas/AccessProfileDocument/allOf/1/properties/entitlements/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/entitlement/BaseEntitlement.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/entitlement/BaseEntitlement.yaml - properties: sourceSchemaObjectType: type: string @@ -90794,7 +115437,7 @@ components: description: Access profiles included in the dimension. items: $ref: '#/components/schemas/RoleDocument/allOf/1/properties/accessProfiles/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/BaseAccessProfile.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/BaseAccessProfile.yaml SavedSearch: type: object allOf: @@ -90812,7 +115455,7 @@ components: properties: type: $ref: '#/components/schemas/Account/allOf/1/properties/ownerIdentity/allOf/0/properties/type' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/DtoType.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/DtoType.yaml id: description: | The id of the object. @@ -90849,12 +115492,12 @@ components: description: | The date the saved search was initially created. $ref: '#/components/schemas/Schedule/properties/expiration' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/DateTime.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/DateTime.yaml modified: description: | The last date the saved search was modified. $ref: '#/components/schemas/Schedule/properties/expiration' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/DateTime.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/DateTime.yaml indices: description: | The names of the Elasticsearch indices in which to search. @@ -91006,7 +115649,7 @@ components: example: false upper: $ref: '#/components/schemas/SavedSearch/allOf/2/properties/filters/allOf/1/properties/range/properties/lower' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/filter/Bound.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/filter/Bound.yaml terms: description: The terms to be filtered. type: array @@ -91088,7 +115731,7 @@ components: days: allOf: - $ref: '#/components/schemas/Schedule/properties/months/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/schedule/Selector.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/schedule/Selector.yaml - description: | The days to execute the search. @@ -91105,7 +115748,7 @@ components: hours: allOf: - $ref: '#/components/schemas/Schedule/properties/months/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/schedule/Selector.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/schedule/Selector.yaml - description: The hours selected. example: type: RANGE @@ -91187,13 +115830,13 @@ components: created: allOf: - $ref: '#/components/schemas/Schedule/properties/expiration' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/DateTime.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/DateTime.yaml description: The date the scheduled search was initially created. readOnly: true modified: allOf: - $ref: '#/components/schemas/Schedule/properties/expiration' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/DateTime.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/DateTime.yaml description: The last date the scheduled search was modified. readOnly: true schedule: @@ -91202,11 +115845,11 @@ components: properties: type: $ref: '#/components/schemas/Schedule/properties/type' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/schedule/ScheduleType.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/schedule/ScheduleType.yaml months: allOf: - $ref: '#/components/schemas/Schedule/properties/months/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/schedule/Selector.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/schedule/Selector.yaml - description: | The months to execute the search. This only applies to schedules with a type of `ANNUALLY`. example: @@ -91220,7 +115863,7 @@ components: days: allOf: - $ref: '#/components/schemas/Schedule/properties/months/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/schedule/Selector.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/schedule/Selector.yaml - description: | The days to execute the search. @@ -91237,7 +115880,7 @@ components: hours: allOf: - $ref: '#/components/schemas/Schedule/properties/months/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/schedule/Selector.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/schedule/Selector.yaml - description: The hours selected. example: type: RANGE @@ -91248,7 +115891,7 @@ components: expiration: description: The schedule expiration date. Latest possible expiration date is '2038-01-19T03:14:07+0000' $ref: '#/components/schemas/Schedule/properties/expiration' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/model/base/DateTime.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/model/base/DateTime.yaml timeZoneId: description: The canonical TZ identifier the schedule will run in (ex. America/New_York). If no timezone is specified, the org's default timezone is used. nullable: true @@ -91412,7 +116055,7 @@ components: items: allOf: - $ref: '#/components/schemas/ProvisioningConfig/properties/managedResourceRefs/items/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ServiceDeskSource.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ServiceDeskSource.yaml example: - type: SOURCE id: 2c9180855d191c59015d291ceb051111 @@ -91469,7 +116112,7 @@ components: ServiceDeskIntegrationTemplateDto: allOf: - $ref: '#/components/schemas/Account/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/BaseCommonDto.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/BaseCommonDto.yaml - type: object description: This is the model for a Service Desk integration template, used to create and edit Service Desk Integrations. required: @@ -91491,7 +116134,7 @@ components: key: value provisioningConfig: $ref: '#/components/schemas/ServiceDeskIntegrationDto/allOf/0/properties/provisioningConfig' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/ProvisioningConfig.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/ProvisioningConfig.yaml ServiceDeskIntegrationTemplateType: description: This represents a Service Desk Integration template type. required: @@ -91751,6 +116394,7 @@ components: - ARM_UTILIZATION_EXTRACT - ARM_CHANGELOG_EXTRACT - USES_UUID + - APPLICATION_DISCOVERY example: AUTHENTICATE description: |- Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. @@ -91944,6 +116588,7 @@ components: example: megapod-useast1 iqServiceVersion: type: string + nullable: true description: The version of the iqService example: iqVersion123 status: @@ -91959,6 +116604,7 @@ components: - SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES - SOURCE_STATE_UNCHECKED_SOURCE - SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS + - SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT description: connection test result example: SOURCE_STATE_UNCHECKED_SOURCE SourceSchedule: @@ -92100,19 +116746,19 @@ components: properties: requiresPeriodicRefresh: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/RequiresPeriodicRefresh.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml input: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/input.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - title: base64Encode type: object properties: requiresPeriodicRefresh: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/RequiresPeriodicRefresh.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml input: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/input.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - title: concat type: object required: @@ -92129,10 +116775,10 @@ components: - Smith requiresPeriodicRefresh: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/RequiresPeriodicRefresh.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml input: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/input.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - title: conditional type: object required: @@ -92157,10 +116803,10 @@ components: example: 'false' requiresPeriodicRefresh: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/RequiresPeriodicRefresh.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml input: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/input.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - title: dateCompare type: object required: @@ -92174,16 +116820,16 @@ components: description: This is the first date to consider (The date that would be on the left hand side of the comparison operation). oneOf: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/AccountAttribute.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/AccountAttribute.yaml - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/6' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/DateFormat.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/DateFormat.yaml secondDate: description: This is the second date to consider (The date that would be on the right hand side of the comparison operation). oneOf: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/AccountAttribute.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/AccountAttribute.yaml - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/6' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/DateFormat.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/DateFormat.yaml operator: type: string description: | @@ -92210,10 +116856,10 @@ components: example: false requiresPeriodicRefresh: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/RequiresPeriodicRefresh.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml input: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/input.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - title: dateFormat type: object properties: @@ -92269,15 +116915,15 @@ components: *If no inputFormat is provided, the transform assumes that it is in ISO8601 format* oneOf: - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/6/properties/inputFormat/oneOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/date-formats/namedConstructs.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/date-formats/namedConstructs.yaml - $ref: '#/components/schemas/Transform/properties/attributes/oneOf/6/properties/inputFormat/oneOf/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/date-formats/simpleDateFormat.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/date-formats/simpleDateFormat.yaml requiresPeriodicRefresh: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/RequiresPeriodicRefresh.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml input: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/input.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - title: dateMath type: object required: @@ -92308,19 +116954,19 @@ components: default: false requiresPeriodicRefresh: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/RequiresPeriodicRefresh.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml input: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/input.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - title: decomposeDiacriticalMarks type: object properties: requiresPeriodicRefresh: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/RequiresPeriodicRefresh.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml input: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/input.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - title: e164phone type: object properties: @@ -92337,10 +116983,10 @@ components: example: US requiresPeriodicRefresh: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/RequiresPeriodicRefresh.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml input: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/input.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - title: firstValid type: object required: @@ -92371,7 +117017,7 @@ components: default: false requiresPeriodicRefresh: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/RequiresPeriodicRefresh.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml - title: rule oneOf: - type: object @@ -92384,7 +117030,7 @@ components: example: Transform Calculation Rule requiresPeriodicRefresh: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/RequiresPeriodicRefresh.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml - type: object required: - name @@ -92457,10 +117103,10 @@ components: example: email requiresPeriodicRefresh: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/RequiresPeriodicRefresh.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml input: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/input.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - title: indexOf type: object required: @@ -92472,10 +117118,10 @@ components: example: admin_ requiresPeriodicRefresh: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/RequiresPeriodicRefresh.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml input: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/input.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - title: iso3166 type: object properties: @@ -92495,10 +117141,10 @@ components: example: alpha2 requiresPeriodicRefresh: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/RequiresPeriodicRefresh.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml input: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/input.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - title: leftPad type: object required: @@ -92518,10 +117164,10 @@ components: example: '0' requiresPeriodicRefresh: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/RequiresPeriodicRefresh.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml input: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/input.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - title: lookup type: object required: @@ -92542,28 +117188,28 @@ components: default: Unknown Region requiresPeriodicRefresh: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/RequiresPeriodicRefresh.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml input: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/input.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - title: lower type: object properties: requiresPeriodicRefresh: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/RequiresPeriodicRefresh.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml input: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/input.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - title: nameNormalizer type: object properties: requiresPeriodicRefresh: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/RequiresPeriodicRefresh.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml input: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/input.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - title: randomAlphaNumeric type: object properties: @@ -92583,10 +117229,10 @@ components: example: '10' requiresPeriodicRefresh: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/RequiresPeriodicRefresh.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml input: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/input.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - title: randomNumeric type: object properties: @@ -92606,10 +117252,10 @@ components: example: '10' requiresPeriodicRefresh: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/RequiresPeriodicRefresh.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml input: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/input.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - title: reference type: object required: @@ -92621,10 +117267,10 @@ components: example: Existing Transform requiresPeriodicRefresh: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/RequiresPeriodicRefresh.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml input: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/input.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - title: replaceAll type: object required: @@ -92640,10 +117286,10 @@ components: ñ: 'n' requiresPeriodicRefresh: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/RequiresPeriodicRefresh.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml input: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/input.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - title: replace type: object required: @@ -92663,10 +117309,10 @@ components: example: ' ' requiresPeriodicRefresh: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/RequiresPeriodicRefresh.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml input: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/input.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - title: rightPad type: object required: @@ -92686,10 +117332,10 @@ components: example: '0' requiresPeriodicRefresh: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/RequiresPeriodicRefresh.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml input: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/input.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - title: split type: object required: @@ -92721,10 +117367,10 @@ components: default: false requiresPeriodicRefresh: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/RequiresPeriodicRefresh.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml input: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/input.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - title: static type: object required: @@ -92739,7 +117385,7 @@ components: url: https://developer.sailpoint.com/idn/docs/transforms/operations/static requiresPeriodicRefresh: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/RequiresPeriodicRefresh.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml - title: substring type: object required: @@ -92780,34 +117426,34 @@ components: format: int32 requiresPeriodicRefresh: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/RequiresPeriodicRefresh.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml input: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/input.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - title: trim type: object properties: requiresPeriodicRefresh: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/RequiresPeriodicRefresh.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml input: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/input.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - title: upper type: object properties: requiresPeriodicRefresh: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/RequiresPeriodicRefresh.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml input: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/input' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/input.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/input.yaml - title: uuid type: object properties: requiresPeriodicRefresh: $ref: '#/components/schemas/Transform/properties/attributes/oneOf/0/properties/requiresPeriodicRefresh' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/transforms/RequiresPeriodicRefresh.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/transforms/RequiresPeriodicRefresh.yaml WorkItems: type: object properties: @@ -92958,7 +117604,7 @@ components: state: allOf: - $ref: '#/components/schemas/ApprovalItems/properties/state/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/WorkItemState.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/WorkItemState.yaml - nullable: true description: A list of items that need to be approved name: @@ -92994,10 +117640,12 @@ components: nullable: true title: type: string + nullable: true description: The form title example: Account Selection for John.Doe subtitle: type: string + nullable: true description: The form subtitle. example: Please select from the following targetUser: @@ -93013,12 +117661,14 @@ components: properties: name: type: string + nullable: true description: Name of the FormItem example: Field1 - type: object properties: label: type: string + nullable: true description: Label of the section example: Section 1 formItems: @@ -93424,7 +118074,7 @@ components: type: array items: $ref: '#/components/schemas/SavedSearch/allOf/2/properties/indices/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/Index.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/Index.yaml example: - identities queryType: @@ -93610,7 +118260,7 @@ components: aggregationsVersion: allOf: - $ref: '#/components/schemas/RoleMetadataBulkUpdateByQueryRequest/properties/query/items/properties/queryVersion/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/ElasticVersion.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/ElasticVersion.yaml - type: string description: |- The version of the language being used for aggregation queries. @@ -93746,13 +118396,13 @@ components: subAggregation: allOf: - $ref: '#/components/schemas/RoleMetadataBulkUpdateByQueryRequest/properties/query/items/properties/aggregations/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/aggregate/Aggregations.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/aggregate/Aggregations.yaml - type: object properties: subAggregation: description: Aggregation to be performed on the result of the parent bucket aggregation. $ref: '#/components/schemas/RoleMetadataBulkUpdateByQueryRequest/properties/query/items/properties/aggregations/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/search/aggregate/Aggregations.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/search/aggregate/Aggregations.yaml sort: description: The fields to be used to sort the search results. Use + or - to specify the sort direction. type: array @@ -93781,7 +118431,7 @@ components: type: object additionalProperties: $ref: '#/components/schemas/SavedSearch/allOf/2/properties/filters/allOf/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/schemas/filter/Filter.yaml + x-miro: /Users/tyler.mairose/development/developer.sailpoint.com/static/api-specs/idn/v2025/schemas/filter/Filter.yaml example: {} example: query": diff --git a/static/code-examples/v3/powershell_code_examples_overlay.yaml b/static/code-examples/v3/powershell_code_examples_overlay.yaml index 12eb2b302..f60bafeec 100644 --- a/static/code-examples/v3/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v3/powershell_code_examples_overlay.yaml @@ -197,14 +197,14 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v3/methods/access-profiles#list-access-profiles source: | - $ForSubadmin = "8c190e6787aa4ed9a90bd9d5344523fb" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID, or the special value **me**, which is shorthand for the calling identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an identity that is not a subadmin. (optional) - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $ForSubadmin = "8c190e6787aa4ed9a90bd9d5344523fb" # String | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. (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) - $Filters = "name eq "SailPoint Support"" # 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: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Composite operators supported: *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + $Filters = "name eq "SailPoint Support"" # 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: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters access profiles to those which are assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) - $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) + $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) # List Access Profiles @@ -5787,11 +5787,11 @@ label: SDK_tools/sdk/powershell/v3/methods/requestable-objects#list-requestable-objects source: | $IdentityId = "e7eab60924f64aa284175b9fa3309599" # String | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) - $Types = "ACCESS_PROFILE" # RequestableObjectType[] | Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice. (optional) + $Types = "ACCESS_PROFILE" # RequestableObjectType[] | Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. (optional) $Types = @"ROLE,ACCESS_PROFILE"@ - $Term = "Finance Role" # String | It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored. (optional) - $Statuses = "AVAILABLE" # RequestableObjectRequestStatus[] | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. (optional) + $Term = "Finance Role" # String | Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. (optional) + $Statuses = "AVAILABLE" # RequestableObjectRequestStatus[] | Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. (optional) $Statuses = @"[ASSIGNED, PENDING]"@ $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) @@ -7529,6 +7529,8 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v3/methods/search-attribute-configuration#get-search-attribute-config source: | + $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) # List Extended Search Attributes @@ -7536,7 +7538,7 @@ Get-SearchAttributeConfig # Below is a request that includes all optional parameters - # Get-SearchAttributeConfig + # Get-SearchAttributeConfig -Limit $Limit -Offset $Offset } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SearchAttributeConfig" Write-Host $_.ErrorDetails @@ -8396,15 +8398,15 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v3/methods/sources#get-source-connections source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. # Get Source Connections by ID try { - Get-SourceConnections -Id $Id + Get-SourceConnections -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-SourceConnections -Id $Id + # Get-SourceConnections -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SourceConnections" Write-Host $_.ErrorDetails @@ -9449,6 +9451,7 @@ label: SDK_tools/sdk/powershell/v3/methods/work-items#complete-work-item source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $Body = "MyBody" # String | Body is the request payload to create form definition request (optional) # Complete a Work Item @@ -9456,7 +9459,7 @@ Complete-WorkItem -Id $Id # Below is a request that includes all optional parameters - # Complete-WorkItem -Id $Id + # Complete-WorkItem -Id $Id -Body $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-WorkItem" Write-Host $_.ErrorDetails @@ -10012,6 +10015,7 @@ "displayName" : "displayName", "attributes" : { "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", "attributeToFilter" : "LifecycleState", "id" : "idn:identity-attributes-changed", "filter.$" : "$.changes[?(@.attribute == 'manager')]" diff --git a/static/code-examples/v3/python_code_examples_overlay.yaml b/static/code-examples/v3/python_code_examples_overlay.yaml new file mode 100644 index 000000000..5e569934f --- /dev/null +++ b/static/code-examples/v3/python_code_examples_overlay.yaml @@ -0,0 +1,11487 @@ +- path: /access-profiles + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-profiles#create-access-profile + source: | + from sailpoint.v3.api.access_profiles_api import AccessProfilesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.access_profile import AccessProfile + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + access_profile = '''{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "created" : "2021-03-01T22:32:58.104Z", + "description" : "Collection of entitlements to read/write the employee database", + "source" : { + "name" : "ODS-AD-SOURCE", + "id" : "2c91809773dee3610173fdb0b6061ef4", + "type" : "SOURCE" + }, + "enabled" : true, + "revocationRequestConfig" : { + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ] + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "accessRequestConfig" : { + "commentsRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "name" : "Employee-database-read-write", + "provisioningCriteria" : { + "children" : [ { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, + "modified" : "2021-03-02T20:22:28.104Z", + "id" : "2c91808a7190d06e01719938fcd20792", + "requestable" : true + }''' # AccessProfile | + try: + # Create Access Profile + new_access_profile = AccessProfile.from_json(access_profile) + results = AccessProfilesApi(api_client).create_access_profile(access_profile=new_access_profile) + # Below is a request that includes all optional parameters + # results = AccessProfilesApi(api_client).create_access_profile(new_access_profile) + print("The response of AccessProfilesApi->create_access_profile:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccessProfilesApi->create_access_profile: %s\n" % e) +- path: /access-profiles/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-profiles#delete-access-profile + source: | + from sailpoint.v3.api.access_profiles_api import AccessProfilesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121919ecca' # str | ID of the Access Profile to delete # str | ID of the Access Profile to delete + try: + # Delete the specified Access Profile + + AccessProfilesApi(api_client).delete_access_profile(id=id) + # Below is a request that includes all optional parameters + # AccessProfilesApi(api_client).delete_access_profile(id) + except Exception as e: + print("Exception when calling AccessProfilesApi->delete_access_profile: %s\n" % e) +- path: /access-profiles/bulk-delete + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-profiles#delete-access-profiles-in-bulk + source: | + from sailpoint.v3.api.access_profiles_api import AccessProfilesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.access_profile_bulk_delete_request import AccessProfileBulkDeleteRequest + from sailpoint.v3.models.access_profile_bulk_delete_response import AccessProfileBulkDeleteResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + access_profile_bulk_delete_request = '''{ + "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], + "bestEffortOnly" : true + }''' # AccessProfileBulkDeleteRequest | + try: + # Delete Access Profile(s) + new_access_profile_bulk_delete_request = AccessProfileBulkDeleteRequest.from_json(access_profile_bulk_delete_request) + results = AccessProfilesApi(api_client).delete_access_profiles_in_bulk(access_profile_bulk_delete_request=new_access_profile_bulk_delete_request) + # Below is a request that includes all optional parameters + # results = AccessProfilesApi(api_client).delete_access_profiles_in_bulk(new_access_profile_bulk_delete_request) + print("The response of AccessProfilesApi->delete_access_profiles_in_bulk:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccessProfilesApi->delete_access_profiles_in_bulk: %s\n" % e) +- path: /access-profiles/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-profiles#get-access-profile + source: | + from sailpoint.v3.api.access_profiles_api import AccessProfilesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.access_profile import AccessProfile + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Access Profile # str | ID of the Access Profile + try: + # Get an Access Profile + + results = AccessProfilesApi(api_client).get_access_profile(id=id) + # Below is a request that includes all optional parameters + # results = AccessProfilesApi(api_client).get_access_profile(id) + print("The response of AccessProfilesApi->get_access_profile:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccessProfilesApi->get_access_profile: %s\n" % e) +- path: /access-profiles/{id}/entitlements + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-profiles#get-access-profile-entitlements + source: | + from sailpoint.v3.api.access_profiles_api import AccessProfilesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.entitlement import Entitlement + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121919ecca' # str | ID of the access profile containing the entitlements. # str | ID of the access profile containing the entitlements. + 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) + filters = 'attribute eq \"memberOf\"' # 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: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (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: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) + try: + # List Access Profile's Entitlements + + results = AccessProfilesApi(api_client).get_access_profile_entitlements(id=id) + # Below is a request that includes all optional parameters + # results = AccessProfilesApi(api_client).get_access_profile_entitlements(id, limit, offset, count, filters, sorters) + print("The response of AccessProfilesApi->get_access_profile_entitlements:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e) +- path: /access-profiles + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-profiles#list-access-profiles + source: | + from sailpoint.v3.api.access_profiles_api import AccessProfilesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.access_profile import AccessProfile + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + for_subadmin = '8c190e6787aa4ed9a90bd9d5344523fb' # str | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. (optional) # str | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity's ID. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. (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) + filters = 'name eq \"SailPoint Support\"' # 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: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (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: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + include_unsegmented = True # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) + try: + # List Access Profiles + + results = AccessProfilesApi(api_client).list_access_profiles() + # Below is a request that includes all optional parameters + # results = AccessProfilesApi(api_client).list_access_profiles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) + print("The response of AccessProfilesApi->list_access_profiles:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e) +- path: /access-profiles/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-profiles#patch-access-profile + source: | + from sailpoint.v3.api.access_profiles_api import AccessProfilesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.access_profile import AccessProfile + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121919ecca' # str | ID of the Access Profile to patch # str | ID of the Access Profile to patch + json_patch_operation = '''[{op=add, path=/entitlements, value=[{id=2c9180857725c14301772a93bb77242d, type=ENTITLEMENT, name=AD User Group}]}]''' # List[JsonPatchOperation] | + try: + # Patch a specified Access Profile + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = AccessProfilesApi(api_client).patch_access_profile(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = AccessProfilesApi(api_client).patch_access_profile(id, new_json_patch_operation) + print("The response of AccessProfilesApi->patch_access_profile:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccessProfilesApi->patch_access_profile: %s\n" % e) +- path: /access-request-approvals/{approvalId}/approve + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-request-approvals#approve-access-request + source: | + from sailpoint.v3.api.access_request_approvals_api import AccessRequestApprovalsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.comment_dto import CommentDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID. + comment_dto = '''{ + "created" : "2017-07-11T18:45:37.098Z", + "author" : { + "name" : "john.doe", + "id" : "2c9180847e25f377017e2ae8cae4650b", + "type" : "IDENTITY" + }, + "comment" : "This is a comment." + }''' # CommentDto | Reviewer's comment. (optional) + try: + # Approve Access Request Approval + + results = AccessRequestApprovalsApi(api_client).approve_access_request(approval_id=approval_id) + # Below is a request that includes all optional parameters + # results = AccessRequestApprovalsApi(api_client).approve_access_request(approval_id, new_comment_dto) + print("The response of AccessRequestApprovalsApi->approve_access_request:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->approve_access_request: %s\n" % e) +- path: /access-request-approvals/{approvalId}/forward + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-request-approvals#forward-access-request + source: | + from sailpoint.v3.api.access_request_approvals_api import AccessRequestApprovalsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.forward_approval_dto import ForwardApprovalDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID. + forward_approval_dto = '''{ + "newOwnerId" : "2c91808568c529c60168cca6f90c1314", + "comment" : "2c91808568c529c60168cca6f90c1313" + }''' # ForwardApprovalDto | Information about the forwarded approval. + try: + # Forward Access Request Approval + new_forward_approval_dto = ForwardApprovalDto.from_json(forward_approval_dto) + results = AccessRequestApprovalsApi(api_client).forward_access_request(approval_id=approval_id, forward_approval_dto=new_forward_approval_dto) + # Below is a request that includes all optional parameters + # results = AccessRequestApprovalsApi(api_client).forward_access_request(approval_id, new_forward_approval_dto) + print("The response of AccessRequestApprovalsApi->forward_access_request:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->forward_access_request: %s\n" % e) +- path: /access-request-approvals/approval-summary + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-request-approvals#get-access-request-approval-summary + source: | + from sailpoint.v3.api.access_request_approvals_api import AccessRequestApprovalsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.approval_summary import ApprovalSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + owner_id = '2c91808568c529c60168cca6f90c1313' # str | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # str | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + from_date = 'from-date=2020-03-19T19:59:11Z' # str | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) # str | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) + try: + # Get Access Requests Approvals Number + + results = AccessRequestApprovalsApi(api_client).get_access_request_approval_summary() + # Below is a request that includes all optional parameters + # results = AccessRequestApprovalsApi(api_client).get_access_request_approval_summary(owner_id, from_date) + print("The response of AccessRequestApprovalsApi->get_access_request_approval_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->get_access_request_approval_summary: %s\n" % e) +- path: /access-request-approvals/completed + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-request-approvals#list-completed-approvals + source: | + from sailpoint.v3.api.access_request_approvals_api import AccessRequestApprovalsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.completed_approval import CompletedApproval + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + owner_id = '2c91808568c529c60168cca6f90c1313' # str | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # str | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (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) + filters = 'id eq \"2c91808568c529c60168cca6f90c1313\"' # 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: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (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: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) + sorters = 'modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + try: + # Completed Access Request Approvals List + + results = AccessRequestApprovalsApi(api_client).list_completed_approvals() + # Below is a request that includes all optional parameters + # results = AccessRequestApprovalsApi(api_client).list_completed_approvals(owner_id, limit, offset, count, filters, sorters) + print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e) +- path: /access-request-approvals/pending + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-request-approvals#list-pending-approvals + source: | + from sailpoint.v3.api.access_request_approvals_api import AccessRequestApprovalsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.pending_approval import PendingApproval + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + owner_id = '2c91808568c529c60168cca6f90c1313' # str | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # str | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (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) + filters = 'id eq \"2c91808568c529c60168cca6f90c1313\"' # 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: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (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: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) + sorters = 'modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + try: + # Pending Access Request Approvals List + + results = AccessRequestApprovalsApi(api_client).list_pending_approvals() + # Below is a request that includes all optional parameters + # results = AccessRequestApprovalsApi(api_client).list_pending_approvals(owner_id, limit, offset, count, filters, sorters) + print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->list_pending_approvals: %s\n" % e) +- path: /access-request-approvals/{approvalId}/reject + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-request-approvals#reject-access-request + source: | + from sailpoint.v3.api.access_request_approvals_api import AccessRequestApprovalsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.comment_dto import CommentDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID. + comment_dto = '''{ + "created" : "2017-07-11T18:45:37.098Z", + "author" : { + "name" : "john.doe", + "id" : "2c9180847e25f377017e2ae8cae4650b", + "type" : "IDENTITY" + }, + "comment" : "This is a comment." + }''' # CommentDto | Reviewer's comment. + try: + # Reject Access Request Approval + new_comment_dto = CommentDto.from_json(comment_dto) + results = AccessRequestApprovalsApi(api_client).reject_access_request(approval_id=approval_id, comment_dto=new_comment_dto) + # Below is a request that includes all optional parameters + # results = AccessRequestApprovalsApi(api_client).reject_access_request(approval_id, new_comment_dto) + print("The response of AccessRequestApprovalsApi->reject_access_request:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccessRequestApprovalsApi->reject_access_request: %s\n" % e) +- path: /access-requests/cancel + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-requests#cancel-access-request + source: | + from sailpoint.v3.api.access_requests_api import AccessRequestsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.cancel_access_request import CancelAccessRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + cancel_access_request = '''{ + "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I requested this role by mistake." + }''' # CancelAccessRequest | + try: + # Cancel Access Request + new_cancel_access_request = CancelAccessRequest.from_json(cancel_access_request) + results = AccessRequestsApi(api_client).cancel_access_request(cancel_access_request=new_cancel_access_request) + # Below is a request that includes all optional parameters + # results = AccessRequestsApi(api_client).cancel_access_request(new_cancel_access_request) + print("The response of AccessRequestsApi->cancel_access_request:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccessRequestsApi->cancel_access_request: %s\n" % e) +- path: /access-requests + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-requests#create-access-request + source: | + from sailpoint.v3.api.access_requests_api import AccessRequestsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.access_request import AccessRequest + from sailpoint.v3.models.access_request_response import AccessRequestResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + access_request = '''{ + "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + } ] + }''' # AccessRequest | + try: + # Submit Access Request + new_access_request = AccessRequest.from_json(access_request) + results = AccessRequestsApi(api_client).create_access_request(access_request=new_access_request) + # Below is a request that includes all optional parameters + # results = AccessRequestsApi(api_client).create_access_request(new_access_request) + print("The response of AccessRequestsApi->create_access_request:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccessRequestsApi->create_access_request: %s\n" % e) +- path: /access-request-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-requests#get-access-request-config + source: | + from sailpoint.v3.api.access_requests_api import AccessRequestsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.access_request_config import AccessRequestConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get Access Request Configuration + + results = AccessRequestsApi(api_client).get_access_request_config() + # Below is a request that includes all optional parameters + # results = AccessRequestsApi(api_client).get_access_request_config() + print("The response of AccessRequestsApi->get_access_request_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccessRequestsApi->get_access_request_config: %s\n" % e) +- path: /access-request-status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-requests#list-access-request-status + source: | + from sailpoint.v3.api.access_requests_api import AccessRequestsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.requested_item_status import RequestedItemStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + requested_for = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # str | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + requested_by = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # str | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + regarding_identity = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # str | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + assigned_to = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) # str | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) + count = False # bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to False) # bool | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to False) + limit = 250 # int | Max number of results to return. (optional) (default to 250) # int | Max number of results to return. (optional) (default to 250) + offset = 10 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + filters = 'accountActivityItemId eq \"2c918086771c86df0177401efcdf54c0\"' # 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: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (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: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) + sorters = 'created' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** (optional) + request_state = 'request-state=EXECUTING' # str | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) # str | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) + try: + # Access Request Status + + results = AccessRequestsApi(api_client).list_access_request_status() + # Below is a request that includes all optional parameters + # results = AccessRequestsApi(api_client).list_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state) + print("The response of AccessRequestsApi->list_access_request_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e) +- path: /access-request-config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/access-requests#set-access-request-config + source: | + from sailpoint.v3.api.access_requests_api import AccessRequestsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.access_request_config import AccessRequestConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + access_request_config = '''{ + "requestOnBehalfOfConfig" : { + "allowRequestOnBehalfOfEmployeeByManager" : true, + "allowRequestOnBehalfOfAnyoneByAnyone" : true + }, + "approvalReminderAndEscalationConfig" : { + "fallbackApproverRef" : { + "name" : "Alison Ferguso", + "id" : "5168015d32f890ca15812c9180835d2e", + "type" : "IDENTITY", + "email" : "alison.ferguso@identitysoon.com" + }, + "maxReminders" : 1, + "daysUntilEscalation" : 0, + "daysBetweenReminders" : 0 + }, + "autoApprovalEnabled" : true, + "entitlementRequestConfig" : { + "requestCommentsRequired" : false, + "deniedCommentsRequired" : false, + "allowEntitlementRequest" : true, + "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" + }, + "reauthorizationEnabled" : true, + "approvalsMustBeExternal" : true + }''' # AccessRequestConfig | + try: + # Update Access Request Configuration + new_access_request_config = AccessRequestConfig.from_json(access_request_config) + results = AccessRequestsApi(api_client).set_access_request_config(access_request_config=new_access_request_config) + # Below is a request that includes all optional parameters + # results = AccessRequestsApi(api_client).set_access_request_config(new_access_request_config) + print("The response of AccessRequestsApi->set_access_request_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccessRequestsApi->set_access_request_config: %s\n" % e) +- path: /account-activities/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/account-activities#get-account-activity + source: | + from sailpoint.v3.api.account_activities_api import AccountActivitiesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.account_activity import AccountActivity + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account activity id # str | The account activity id + try: + # Get an Account Activity + + results = AccountActivitiesApi(api_client).get_account_activity(id=id) + # Below is a request that includes all optional parameters + # results = AccountActivitiesApi(api_client).get_account_activity(id) + print("The response of AccountActivitiesApi->get_account_activity:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountActivitiesApi->get_account_activity: %s\n" % e) +- path: /account-activities + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/account-activities#list-account-activities + source: | + from sailpoint.v3.api.account_activities_api import AccountActivitiesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.account_activity import AccountActivity + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + requested_for = '2c91808568c529c60168cca6f90c1313' # str | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # str | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + requested_by = '2c91808568c529c60168cca6f90c1313' # str | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # str | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + regarding_identity = '2c91808568c529c60168cca6f90c1313' # str | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # str | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (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) + filters = 'type eq \"Identity Refresh\"' # 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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (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: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) + sorters = 'created' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) + try: + # List Account Activities + + results = AccountActivitiesApi(api_client).list_account_activities() + # Below is a request that includes all optional parameters + # results = AccountActivitiesApi(api_client).list_account_activities(requested_for, requested_by, regarding_identity, limit, offset, count, filters, sorters) + print("The response of AccountActivitiesApi->list_account_activities:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/account-usages#get-usages-by-account-id + source: | + from sailpoint.v3.api.account_usages_api import AccountUsagesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.account_usage import AccountUsage + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account + 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) + sorters = '-date' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + try: + # Returns account usage insights + + results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id) + # Below is a request that includes all optional parameters + # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) + print("The response of AccountUsagesApi->get_usages_by_account_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) +- path: /accounts + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/accounts#create-account + source: | + from sailpoint.v3.api.accounts_api import AccountsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.account_attributes_create import AccountAttributesCreate + from sailpoint.v3.models.accounts_async_result import AccountsAsyncResult + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + account_attributes_create = '''{ + "attributes" : { + "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + }''' # AccountAttributesCreate | + try: + # Create Account + new_account_attributes_create = AccountAttributesCreate.from_json(account_attributes_create) + results = AccountsApi(api_client).create_account(account_attributes_create=new_account_attributes_create) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).create_account(new_account_attributes_create) + print("The response of AccountsApi->create_account:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountsApi->create_account: %s\n" % e) +- path: /accounts/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/accounts#delete-account + source: | + from sailpoint.v3.api.accounts_api import AccountsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.accounts_async_result import AccountsAsyncResult + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. + try: + # Delete Account + + results = AccountsApi(api_client).delete_account(id=id) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).delete_account(id) + print("The response of AccountsApi->delete_account:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountsApi->delete_account: %s\n" % e) +- path: /accounts/{id}/disable + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/accounts#disable-account + source: | + from sailpoint.v3.api.accounts_api import AccountsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.account_toggle_request import AccountToggleRequest + from sailpoint.v3.models.accounts_async_result import AccountsAsyncResult + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id + account_toggle_request = '''{ + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + }''' # AccountToggleRequest | + try: + # Disable Account + new_account_toggle_request = AccountToggleRequest.from_json(account_toggle_request) + results = AccountsApi(api_client).disable_account(id=id, account_toggle_request=new_account_toggle_request) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).disable_account(id, new_account_toggle_request) + print("The response of AccountsApi->disable_account:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountsApi->disable_account: %s\n" % e) +- path: /accounts/{id}/enable + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/accounts#enable-account + source: | + from sailpoint.v3.api.accounts_api import AccountsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.account_toggle_request import AccountToggleRequest + from sailpoint.v3.models.accounts_async_result import AccountsAsyncResult + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id + account_toggle_request = '''{ + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + }''' # AccountToggleRequest | + try: + # Enable Account + new_account_toggle_request = AccountToggleRequest.from_json(account_toggle_request) + results = AccountsApi(api_client).enable_account(id=id, account_toggle_request=new_account_toggle_request) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).enable_account(id, new_account_toggle_request) + print("The response of AccountsApi->enable_account:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountsApi->enable_account: %s\n" % e) +- path: /accounts/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/accounts#get-account + source: | + from sailpoint.v3.api.accounts_api import AccountsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.account import Account + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. + try: + # Account Details + + results = AccountsApi(api_client).get_account(id=id) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).get_account(id) + print("The response of AccountsApi->get_account:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountsApi->get_account: %s\n" % e) +- path: /accounts/{id}/entitlements + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/accounts#get-account-entitlements + source: | + from sailpoint.v3.api.accounts_api import AccountsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.entitlement import Entitlement + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id + 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: + # Account Entitlements + + results = AccountsApi(api_client).get_account_entitlements(id=id) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).get_account_entitlements(id, limit, offset, count) + print("The response of AccountsApi->get_account_entitlements:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e) +- path: /accounts + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/accounts#list-accounts + source: | + from sailpoint.v3.api.accounts_api import AccountsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.account import Account + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + 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) + detail_level = 'FULL' # str | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) # str | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) + filters = 'identityId eq \"2c9180858082150f0180893dbaf44201\"' # 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: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (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: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (optional) + sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) + try: + # Accounts List + + results = AccountsApi(api_client).list_accounts() + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).list_accounts(limit, offset, count, detail_level, filters, sorters) + print("The response of AccountsApi->list_accounts:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountsApi->list_accounts: %s\n" % e) +- path: /accounts/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/accounts#put-account + source: | + from sailpoint.v3.api.accounts_api import AccountsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.account_attributes import AccountAttributes + from sailpoint.v3.models.accounts_async_result import AccountsAsyncResult + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. + account_attributes = '''{ + "attributes" : { + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + }''' # AccountAttributes | + try: + # Update Account + new_account_attributes = AccountAttributes.from_json(account_attributes) + results = AccountsApi(api_client).put_account(id=id, account_attributes=new_account_attributes) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).put_account(id, new_account_attributes) + print("The response of AccountsApi->put_account:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountsApi->put_account: %s\n" % e) +- path: /accounts/{id}/reload + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/accounts#submit-reload-account + source: | + from sailpoint.v3.api.accounts_api import AccountsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.accounts_async_result import AccountsAsyncResult + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id + try: + # Reload Account + + results = AccountsApi(api_client).submit_reload_account(id=id) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).submit_reload_account(id) + print("The response of AccountsApi->submit_reload_account:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountsApi->submit_reload_account: %s\n" % e) +- path: /accounts/{id}/unlock + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/accounts#unlock-account + source: | + from sailpoint.v3.api.accounts_api import AccountsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.account_unlock_request import AccountUnlockRequest + from sailpoint.v3.models.accounts_async_result import AccountsAsyncResult + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account ID. # str | The account ID. + account_unlock_request = '''{ + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", + "unlockIDNAccount" : false + }''' # AccountUnlockRequest | + try: + # Unlock Account + new_account_unlock_request = AccountUnlockRequest.from_json(account_unlock_request) + results = AccountsApi(api_client).unlock_account(id=id, account_unlock_request=new_account_unlock_request) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).unlock_account(id, new_account_unlock_request) + print("The response of AccountsApi->unlock_account:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountsApi->unlock_account: %s\n" % e) +- path: /accounts/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/accounts#update-account + source: | + from sailpoint.v3.api.accounts_api import AccountsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID. + request_body = '''[{op=remove, path=/identityId}]''' # List[object] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + try: + # Update Account + new_request_body = RequestBody.from_json(request_body) + results = AccountsApi(api_client).update_account(id=id, request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = AccountsApi(api_client).update_account(id, new_request_body) + print("The response of AccountsApi->update_account:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccountsApi->update_account: %s\n" % e) +- path: /discovered-applications + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/application-discovery#get-discovered-applications + source: | + from sailpoint.v3.api.application_discovery_api import ApplicationDiscoveryApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.get_discovered_applications200_response_inner import GetDiscoveredApplications200ResponseInner + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + 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) + detail = 'FULL' # str | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) # str | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) + filter = 'name eq \"Okta\" and description co \"Okta\" and discoverySource in (\"csv\", \"Okta Saas\")' # 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: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (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: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional) + try: + # Get Discovered Applications for Tenant + + results = ApplicationDiscoveryApi(api_client).get_discovered_applications() + # Below is a request that includes all optional parameters + # results = ApplicationDiscoveryApi(api_client).get_discovered_applications(limit, offset, detail, filter, sorters) + print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e) +- path: /manual-discover-applications-template + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/application-discovery#get-manual-discover-applications-csv-template + source: | + from sailpoint.v3.api.application_discovery_api import ApplicationDiscoveryApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.manual_discover_applications_template import ManualDiscoverApplicationsTemplate + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Download CSV Template for Discovery + + results = ApplicationDiscoveryApi(api_client).get_manual_discover_applications_csv_template() + # Below is a request that includes all optional parameters + # results = ApplicationDiscoveryApi(api_client).get_manual_discover_applications_csv_template() + print("The response of ApplicationDiscoveryApi->get_manual_discover_applications_csv_template:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ApplicationDiscoveryApi->get_manual_discover_applications_csv_template: %s\n" % e) +- path: /manual-discover-applications + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/application-discovery#send-manual-discover-applications-csv-template + source: | + from sailpoint.v3.api.application_discovery_api import ApplicationDiscoveryApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + file = None # bytearray | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. # bytearray | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. + try: + # Upload CSV to Discover Applications + + ApplicationDiscoveryApi(api_client).send_manual_discover_applications_csv_template(file=file) + # Below is a request that includes all optional parameters + # ApplicationDiscoveryApi(api_client).send_manual_discover_applications_csv_template(file) + except Exception as e: + print("Exception when calling ApplicationDiscoveryApi->send_manual_discover_applications_csv_template: %s\n" % e) +- path: /auth-users/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/auth-users#get-auth-user + source: | + from sailpoint.v3.api.auth_users_api import AuthUsersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.auth_user import AuthUser + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID + try: + # Auth User Details + + results = AuthUsersApi(api_client).get_auth_user(id=id) + # Below is a request that includes all optional parameters + # results = AuthUsersApi(api_client).get_auth_user(id) + print("The response of AuthUsersApi->get_auth_user:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AuthUsersApi->get_auth_user: %s\n" % e) +- path: /auth-users/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/auth-users#patch-auth-user + source: | + from sailpoint.v3.api.auth_users_api import AuthUsersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.auth_user import AuthUser + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID + json_patch_operation = '''[{op=replace, path=/capabilities, value=[ORG_ADMIN]}]''' # List[JsonPatchOperation] | A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + try: + # Auth User Update + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = AuthUsersApi(api_client).patch_auth_user(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = AuthUsersApi(api_client).patch_auth_user(id, new_json_patch_operation) + print("The response of AuthUsersApi->patch_auth_user:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AuthUsersApi->patch_auth_user: %s\n" % e) +- path: /brandings + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/branding#create-branding-item + source: | + from sailpoint.v3.api.branding_api import BrandingApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.branding_item import BrandingItem + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + name = 'name_example' # str | name of branding item # str | name of branding item + product_name = 'product_name_example' # str | product name # str | product name + action_button_color = 'action_button_color_example' # str | hex value of color for action button (optional) # str | hex value of color for action button (optional) + active_link_color = 'active_link_color_example' # str | hex value of color for link (optional) # str | hex value of color for link (optional) + navigation_color = 'navigation_color_example' # str | hex value of color for navigation bar (optional) # str | hex value of color for navigation bar (optional) + email_from_address = 'email_from_address_example' # str | email from address (optional) # str | email from address (optional) + login_informational_message = 'login_informational_message_example' # str | login information message (optional) # str | login information message (optional) + file_standard = None # bytearray | png file with logo (optional) # bytearray | png file with logo (optional) + try: + # Create a branding item + + results = BrandingApi(api_client).create_branding_item(name=name, product_name=product_name) + # Below is a request that includes all optional parameters + # results = BrandingApi(api_client).create_branding_item(name, product_name, action_button_color, active_link_color, navigation_color, email_from_address, login_informational_message, file_standard) + print("The response of BrandingApi->create_branding_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling BrandingApi->create_branding_item: %s\n" % e) +- path: /brandings/{name} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/branding#delete-branding + source: | + from sailpoint.v3.api.branding_api import BrandingApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + name = 'default' # str | The name of the branding item to be deleted # str | The name of the branding item to be deleted + try: + # Delete a branding item + + BrandingApi(api_client).delete_branding(name=name) + # Below is a request that includes all optional parameters + # BrandingApi(api_client).delete_branding(name) + except Exception as e: + print("Exception when calling BrandingApi->delete_branding: %s\n" % e) +- path: /brandings/{name} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/branding#get-branding + source: | + from sailpoint.v3.api.branding_api import BrandingApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.branding_item import BrandingItem + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + name = 'default' # str | The name of the branding item to be retrieved # str | The name of the branding item to be retrieved + try: + # Get a branding item + + results = BrandingApi(api_client).get_branding(name=name) + # Below is a request that includes all optional parameters + # results = BrandingApi(api_client).get_branding(name) + print("The response of BrandingApi->get_branding:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling BrandingApi->get_branding: %s\n" % e) +- path: /brandings + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/branding#get-branding-list + source: | + from sailpoint.v3.api.branding_api import BrandingApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.branding_item import BrandingItem + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # List of branding items + + results = BrandingApi(api_client).get_branding_list() + # Below is a request that includes all optional parameters + # results = BrandingApi(api_client).get_branding_list() + print("The response of BrandingApi->get_branding_list:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling BrandingApi->get_branding_list: %s\n" % e) +- path: /brandings/{name} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/branding#set-branding-item + source: | + from sailpoint.v3.api.branding_api import BrandingApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.branding_item import BrandingItem + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + name = 'default' # str | The name of the branding item to be retrieved # str | The name of the branding item to be retrieved + name2 = 'name_example' # str | name of branding item # str | name of branding item + product_name = 'product_name_example' # str | product name # str | product name + action_button_color = 'action_button_color_example' # str | hex value of color for action button (optional) # str | hex value of color for action button (optional) + active_link_color = 'active_link_color_example' # str | hex value of color for link (optional) # str | hex value of color for link (optional) + navigation_color = 'navigation_color_example' # str | hex value of color for navigation bar (optional) # str | hex value of color for navigation bar (optional) + email_from_address = 'email_from_address_example' # str | email from address (optional) # str | email from address (optional) + login_informational_message = 'login_informational_message_example' # str | login information message (optional) # str | login information message (optional) + file_standard = None # bytearray | png file with logo (optional) # bytearray | png file with logo (optional) + try: + # Update a branding item + + results = BrandingApi(api_client).set_branding_item(name=name, name2=name2, product_name=product_name) + # Below is a request that includes all optional parameters + # results = BrandingApi(api_client).set_branding_item(name, name2, product_name, action_button_color, active_link_color, navigation_color, email_from_address, login_informational_message, file_standard) + print("The response of BrandingApi->set_branding_item:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling BrandingApi->set_branding_item: %s\n" % e) +- path: /campaign-filters + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaign-filters#create-campaign-filter + source: | + from sailpoint.v3.api.certification_campaign_filters_api import CertificationCampaignFiltersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.campaign_filter_details import CampaignFilterDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + campaign_filter_details = '''{ + "owner" : "SailPoint Support", + "mode" : "INCLUSION", + "isSystemFilter" : false, + "name" : "Identity Attribute Campaign Filter", + "description" : "Campaign filter to certify data based on an identity attribute's specified property.", + "id" : "5ec18cef39020d6fd7a60ad3970aba61", + "criteriaList" : [ { + "type" : "IDENTITY_ATTRIBUTE", + "property" : "displayName", + "value" : "support", + "operation" : "CONTAINS", + "negateResult" : false, + "shortCircuit" : false, + "recordChildMatches" : false, + "suppressMatchedItems" : false + } ] + }''' # CampaignFilterDetails | + try: + # Create Campaign Filter + new_campaign_filter_details = CampaignFilterDetails.from_json(campaign_filter_details) + results = CertificationCampaignFiltersApi(api_client).create_campaign_filter(campaign_filter_details=new_campaign_filter_details) + # Below is a request that includes all optional parameters + # results = CertificationCampaignFiltersApi(api_client).create_campaign_filter(new_campaign_filter_details) + print("The response of CertificationCampaignFiltersApi->create_campaign_filter:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->create_campaign_filter: %s\n" % e) +- path: /campaign-filters/delete + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaign-filters#delete-campaign-filters + source: | + from sailpoint.v3.api.certification_campaign_filters_api import CertificationCampaignFiltersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + request_body = '''['request_body_example']''' # List[str] | A json list of IDs of campaign filters to delete. + try: + # Deletes Campaign Filters + new_request_body = RequestBody.from_json(request_body) + CertificationCampaignFiltersApi(api_client).delete_campaign_filters(request_body=new_request_body) + # Below is a request that includes all optional parameters + # CertificationCampaignFiltersApi(api_client).delete_campaign_filters(new_request_body) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->delete_campaign_filters: %s\n" % e) +- path: /campaign-filters/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaign-filters#get-campaign-filter-by-id + source: | + from sailpoint.v3.api.certification_campaign_filters_api import CertificationCampaignFiltersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.campaign_filter_details import CampaignFilterDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'e9f9a1397b842fd5a65842087040d3ac' # str | The ID of the campaign filter to be retrieved. # str | The ID of the campaign filter to be retrieved. + try: + # Get Campaign Filter by ID + + results = CertificationCampaignFiltersApi(api_client).get_campaign_filter_by_id(id=id) + # Below is a request that includes all optional parameters + # results = CertificationCampaignFiltersApi(api_client).get_campaign_filter_by_id(id) + print("The response of CertificationCampaignFiltersApi->get_campaign_filter_by_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->get_campaign_filter_by_id: %s\n" % e) +- path: /campaign-filters + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaign-filters#list-campaign-filters + source: | + from sailpoint.v3.api.certification_campaign_filters_api import CertificationCampaignFiltersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.list_campaign_filters200_response import ListCampaignFilters200Response + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + 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) + start = 0 # int | Start/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 | Start/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) + include_system_filters = True # bool | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to True) # bool | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to True) + try: + # List Campaign Filters + + results = CertificationCampaignFiltersApi(api_client).list_campaign_filters() + # Below is a request that includes all optional parameters + # results = CertificationCampaignFiltersApi(api_client).list_campaign_filters(limit, start, include_system_filters) + print("The response of CertificationCampaignFiltersApi->list_campaign_filters:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->list_campaign_filters: %s\n" % e) +- path: /campaign-filters/{id} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaign-filters#update-campaign-filter + source: | + from sailpoint.v3.api.certification_campaign_filters_api import CertificationCampaignFiltersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.campaign_filter_details import CampaignFilterDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + filter_id = 'e9f9a1397b842fd5a65842087040d3ac' # str | The ID of the campaign filter being modified. # str | The ID of the campaign filter being modified. + campaign_filter_details = '''{ + "owner" : "SailPoint Support", + "mode" : "INCLUSION", + "isSystemFilter" : false, + "name" : "Identity Attribute Campaign Filter", + "description" : "Campaign filter to certify data based on an identity attribute's specified property.", + "id" : "5ec18cef39020d6fd7a60ad3970aba61", + "criteriaList" : [ { + "type" : "IDENTITY_ATTRIBUTE", + "property" : "displayName", + "value" : "support", + "operation" : "CONTAINS", + "negateResult" : false, + "shortCircuit" : false, + "recordChildMatches" : false, + "suppressMatchedItems" : false + } ] + }''' # CampaignFilterDetails | A campaign filter details with updated field values. + try: + # Updates a Campaign Filter + new_campaign_filter_details = CampaignFilterDetails.from_json(campaign_filter_details) + results = CertificationCampaignFiltersApi(api_client).update_campaign_filter(filter_id=filter_id, campaign_filter_details=new_campaign_filter_details) + # Below is a request that includes all optional parameters + # results = CertificationCampaignFiltersApi(api_client).update_campaign_filter(filter_id, new_campaign_filter_details) + print("The response of CertificationCampaignFiltersApi->update_campaign_filter:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationCampaignFiltersApi->update_campaign_filter: %s\n" % e) +- path: /campaigns/{id}/complete + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#complete-campaign + source: | + from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.campaign_complete_options import CampaignCompleteOptions + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Campaign ID. # str | Campaign ID. + campaign_complete_options = '''{ + "autoCompleteAction" : "REVOKE" + }''' # CampaignCompleteOptions | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE (optional) + try: + # Complete a Campaign + + results = CertificationCampaignsApi(api_client).complete_campaign(id=id) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).complete_campaign(id, new_campaign_complete_options) + print("The response of CertificationCampaignsApi->complete_campaign:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->complete_campaign: %s\n" % e) +- path: /campaigns + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#create-campaign + source: | + from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.campaign import Campaign + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + campaign = '''{ + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + }''' # Campaign | + try: + # Create a campaign + new_campaign = Campaign.from_json(campaign) + results = CertificationCampaignsApi(api_client).create_campaign(campaign=new_campaign) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).create_campaign(new_campaign) + print("The response of CertificationCampaignsApi->create_campaign:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->create_campaign: %s\n" % e) +- path: /campaign-templates + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#create-campaign-template + source: | + from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.campaign_template import CampaignTemplate + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + campaign_template = '''{ + "ownerRef" : { + "name" : "Mister Manager", + "id" : "2c918086676d3e0601677611dbde220f", + "type" : "IDENTITY", + "email" : "mr.manager@example.com" + }, + "deadlineDuration" : "P2W", + "created" : "2020-03-05T22:44:00.364Z", + "scheduled" : false, + "name" : "Manager Campaign Template", + "description" : "Template for the annual manager campaign.", + "modified" : "2020-03-05T22:52:09.969Z", + "campaign" : { + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + }, + "id" : "2c9079b270a266a60170a277bb960008" + }''' # CampaignTemplate | + try: + # Create a Campaign Template + new_campaign_template = CampaignTemplate.from_json(campaign_template) + results = CertificationCampaignsApi(api_client).create_campaign_template(campaign_template=new_campaign_template) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).create_campaign_template(new_campaign_template) + print("The response of CertificationCampaignsApi->create_campaign_template:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->create_campaign_template: %s\n" % e) +- path: /campaign-templates/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#delete-campaign-template + source: | + from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template being deleted. # str | ID of the campaign template being deleted. + try: + # Delete a Campaign Template + + CertificationCampaignsApi(api_client).delete_campaign_template(id=id) + # Below is a request that includes all optional parameters + # CertificationCampaignsApi(api_client).delete_campaign_template(id) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->delete_campaign_template: %s\n" % e) +- path: /campaign-templates/{id}/schedule + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#delete-campaign-template-schedule + source: | + from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '04bedce387bd47b2ae1f86eb0bb36dee' # str | ID of the campaign template whose schedule is being deleted. # str | ID of the campaign template whose schedule is being deleted. + try: + # Delete Campaign Template Schedule + + CertificationCampaignsApi(api_client).delete_campaign_template_schedule(id=id) + # Below is a request that includes all optional parameters + # CertificationCampaignsApi(api_client).delete_campaign_template_schedule(id) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->delete_campaign_template_schedule: %s\n" % e) +- path: /campaigns/delete + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#delete-campaigns + source: | + from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.campaigns_delete_request import CampaignsDeleteRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + campaigns_delete_request = '''{ + "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] + }''' # CampaignsDeleteRequest | IDs of the campaigns to delete. + try: + # Delete Campaigns + new_campaigns_delete_request = CampaignsDeleteRequest.from_json(campaigns_delete_request) + results = CertificationCampaignsApi(api_client).delete_campaigns(campaigns_delete_request=new_campaigns_delete_request) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).delete_campaigns(new_campaigns_delete_request) + print("The response of CertificationCampaignsApi->delete_campaigns:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->delete_campaigns: %s\n" % e) +- path: /campaigns + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#get-active-campaigns + source: | + from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + detail = 'FULL' # str | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) # str | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (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) + filters = 'name eq \"Manager Campaign\"' # 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: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* (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: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* (optional) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** (optional) + try: + # List Campaigns + + results = CertificationCampaignsApi(api_client).get_active_campaigns() + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).get_active_campaigns(detail, limit, offset, count, filters, sorters) + print("The response of CertificationCampaignsApi->get_active_campaigns:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e) +- path: /campaigns/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#get-campaign + source: | + from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign to be retrieved. # str | ID of the campaign to be retrieved. + detail = 'FULL' # str | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) # str | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) + try: + # Get Campaign + + results = CertificationCampaignsApi(api_client).get_campaign(id=id) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).get_campaign(id, detail) + print("The response of CertificationCampaignsApi->get_campaign:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign: %s\n" % e) +- path: /campaigns/{id}/reports + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#get-campaign-reports + source: | + from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.campaign_report import CampaignReport + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign whose reports are being fetched. # str | ID of the campaign whose reports are being fetched. + try: + # Get Campaign Reports + + results = CertificationCampaignsApi(api_client).get_campaign_reports(id=id) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).get_campaign_reports(id) + print("The response of CertificationCampaignsApi->get_campaign_reports:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e) +- path: /campaigns/reports-configuration + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#get-campaign-reports-config + source: | + from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.campaign_reports_config import CampaignReportsConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get Campaign Reports Configuration + + results = CertificationCampaignsApi(api_client).get_campaign_reports_config() + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).get_campaign_reports_config() + print("The response of CertificationCampaignsApi->get_campaign_reports_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_reports_config: %s\n" % e) +- path: /campaign-templates/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#get-campaign-template + source: | + from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.campaign_template import CampaignTemplate + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180835d191a86015d28455b4a2329' # str | Requested campaign template's ID. # str | Requested campaign template's ID. + try: + # Get a Campaign Template + + results = CertificationCampaignsApi(api_client).get_campaign_template(id=id) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).get_campaign_template(id) + print("The response of CertificationCampaignsApi->get_campaign_template:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_template: %s\n" % e) +- path: /campaign-templates/{id}/schedule + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#get-campaign-template-schedule + source: | + from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.schedule import Schedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '04bedce387bd47b2ae1f86eb0bb36dee' # str | ID of the campaign template whose schedule is being fetched. # str | ID of the campaign template whose schedule is being fetched. + try: + # Get Campaign Template Schedule + + results = CertificationCampaignsApi(api_client).get_campaign_template_schedule(id=id) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).get_campaign_template_schedule(id) + print("The response of CertificationCampaignsApi->get_campaign_template_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_template_schedule: %s\n" % e) +- path: /campaign-templates + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#get-campaign-templates + source: | + from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.campaign_template import CampaignTemplate + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + 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) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + filters = 'name eq \"manager template\"' # 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: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (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: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) + try: + # List Campaign Templates + + results = CertificationCampaignsApi(api_client).get_campaign_templates() + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).get_campaign_templates(limit, offset, count, sorters, filters) + print("The response of CertificationCampaignsApi->get_campaign_templates:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e) +- path: /campaigns/{id}/reassign + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#move + source: | + from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.admin_review_reassign import AdminReviewReassign + from sailpoint.v3.models.certification_task import CertificationTask + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification campaign ID # str | The certification campaign ID + admin_review_reassign = '''{ + "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], + "reason" : "reassigned for some reason", + "reassignTo" : { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "IDENTITY" + } + }''' # AdminReviewReassign | + try: + # Reassign Certifications + new_admin_review_reassign = AdminReviewReassign.from_json(admin_review_reassign) + results = CertificationCampaignsApi(api_client).move(id=id, admin_review_reassign=new_admin_review_reassign) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).move(id, new_admin_review_reassign) + print("The response of CertificationCampaignsApi->move:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->move: %s\n" % e) +- path: /campaign-templates/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#patch-campaign-template + source: | + from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.campaign_template import CampaignTemplate + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template being modified. # str | ID of the campaign template being modified. + json_patch_operation = '''[{op=replace, path=/description, value=Updated description!}, {op=replace, path=/campaign/filter/id, value=ff80818155fe8c080155fe8d925b0316}]''' # List[JsonPatchOperation] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) + try: + # Update a Campaign Template + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = CertificationCampaignsApi(api_client).patch_campaign_template(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).patch_campaign_template(id, new_json_patch_operation) + print("The response of CertificationCampaignsApi->patch_campaign_template:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->patch_campaign_template: %s\n" % e) +- path: /campaigns/reports-configuration + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#set-campaign-reports-config + source: | + from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.campaign_reports_config import CampaignReportsConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + campaign_reports_config = '''{ + "identityAttributeColumns" : [ "firstname", "lastname" ] + }''' # CampaignReportsConfig | Campaign report configuration. + try: + # Set Campaign Reports Configuration + new_campaign_reports_config = CampaignReportsConfig.from_json(campaign_reports_config) + results = CertificationCampaignsApi(api_client).set_campaign_reports_config(campaign_reports_config=new_campaign_reports_config) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).set_campaign_reports_config(new_campaign_reports_config) + print("The response of CertificationCampaignsApi->set_campaign_reports_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->set_campaign_reports_config: %s\n" % e) +- path: /campaign-templates/{id}/schedule + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#set-campaign-template-schedule + source: | + from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.schedule import Schedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '04bedce387bd47b2ae1f86eb0bb36dee' # str | ID of the campaign template being scheduled. # str | ID of the campaign template being scheduled. + schedule = '''{ + "hours" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "months" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "timeZoneId" : "CST", + "days" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "expiration" : "2000-01-23T04:56:07.000+00:00", + "type" : "WEEKLY" + }''' # Schedule | (optional) + try: + # Set Campaign Template Schedule + + CertificationCampaignsApi(api_client).set_campaign_template_schedule(id=id) + # Below is a request that includes all optional parameters + # CertificationCampaignsApi(api_client).set_campaign_template_schedule(id, new_schedule) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->set_campaign_template_schedule: %s\n" % e) +- path: /campaigns/{id}/activate + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#start-campaign + source: | + from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.activate_campaign_options import ActivateCampaignOptions + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Campaign ID. # str | Campaign ID. + activate_campaign_options = '''{ + "timeZone" : "-05:00" + }''' # ActivateCampaignOptions | Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. (optional) + try: + # Activate a Campaign + + results = CertificationCampaignsApi(api_client).start_campaign(id=id) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).start_campaign(id, new_activate_campaign_options) + print("The response of CertificationCampaignsApi->start_campaign:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_campaign: %s\n" % e) +- path: /campaigns/{id}/run-remediation-scan + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#start-campaign-remediation-scan + source: | + from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign the remediation scan is being run for. # str | ID of the campaign the remediation scan is being run for. + try: + # Run Campaign Remediation Scan + + results = CertificationCampaignsApi(api_client).start_campaign_remediation_scan(id=id) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).start_campaign_remediation_scan(id) + print("The response of CertificationCampaignsApi->start_campaign_remediation_scan:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_campaign_remediation_scan: %s\n" % e) +- path: /campaigns/{id}/run-report/{type} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#start-campaign-report + source: | + from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_type import ReportType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign the report is being run for. # str | ID of the campaign the report is being run for. + type = sailpoint.v3.ReportType() # ReportType | Type of the report to run. # ReportType | Type of the report to run. + try: + # Run Campaign Report + + results = CertificationCampaignsApi(api_client).start_campaign_report(id=id, type=type) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).start_campaign_report(id, type) + print("The response of CertificationCampaignsApi->start_campaign_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_campaign_report: %s\n" % e) +- path: /campaign-templates/{id}/generate + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#start-generate-campaign-template + source: | + from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.campaign_reference import CampaignReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template to use for generation. # str | ID of the campaign template to use for generation. + try: + # Generate a Campaign from Template + + results = CertificationCampaignsApi(api_client).start_generate_campaign_template(id=id) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).start_generate_campaign_template(id) + print("The response of CertificationCampaignsApi->start_generate_campaign_template:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->start_generate_campaign_template: %s\n" % e) +- path: /campaigns/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-campaigns#update-campaign + source: | + from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.v3.models.slim_campaign import SlimCampaign + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign template being modified. # str | ID of the campaign template being modified. + json_patch_operation = '''[{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}]''' # List[JsonPatchOperation] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline + try: + # Update a Campaign + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = CertificationCampaignsApi(api_client).update_campaign(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = CertificationCampaignsApi(api_client).update_campaign(id, new_json_patch_operation) + print("The response of CertificationCampaignsApi->update_campaign:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e) +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-access-summaries + source: | + from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.access_summary import AccessSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for + 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) + filters = 'access.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # 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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + sorters = 'access.name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + try: + # Access Summaries + + results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-decision-summary + source: | + from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.identity_cert_decision_summary import IdentityCertDecisionSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID + filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # 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: **identitySummary.id**: *eq, in* (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: **identitySummary.id**: *eq, in* (optional) + try: + # Summary of Certification Decisions + + results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters) + print("The response of CertificationSummariesApi->get_identity_decision_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e) +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-summaries + source: | + from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + 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) + filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # 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: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (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: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + try: + # Identity Summaries for Campaign Certification + + results = CertificationSummariesApi(api_client).get_identity_summaries(id=id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) + print("The response of CertificationSummariesApi->get_identity_summaries:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certification-summaries#get-identity-summary + source: | + from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.certification_identity_summary import CertificationIdentitySummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID + try: + # Summary for Identity + + results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id) + # Below is a request that includes all optional parameters + # results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id) + print("The response of CertificationSummariesApi->get_identity_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e) +- path: /certification-tasks/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certifications#get-certification-task + source: | + from sailpoint.v3.api.certifications_api import CertificationsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.certification_task import CertificationTask + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '63b32151-26c0-42f4-9299-8898dc1c9daa' # str | The task ID # str | The task ID + try: + # Certification Task by ID + + results = CertificationsApi(api_client).get_certification_task(id=id) + # Below is a request that includes all optional parameters + # results = CertificationsApi(api_client).get_certification_task(id) + print("The response of CertificationsApi->get_certification_task:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationsApi->get_certification_task: %s\n" % e) +- path: /certifications/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certifications#get-identity-certification + source: | + from sailpoint.v3.api.certifications_api import CertificationsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.identity_certification_dto import IdentityCertificationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification id # str | The certification id + try: + # Identity Certification by ID + + results = CertificationsApi(api_client).get_identity_certification(id=id) + # Below is a request that includes all optional parameters + # results = CertificationsApi(api_client).get_identity_certification(id) + print("The response of CertificationsApi->get_identity_certification:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationsApi->get_identity_certification: %s\n" % e) +- path: /certifications/{certificationId}/access-review-items/{itemId}/permissions + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certifications#get-identity-certification-item-permissions + source: | + from sailpoint.v3.api.certifications_api import CertificationsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.permission_dto import PermissionDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + certification_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID + item_id = '2c91808671bcbab40171bd945d961227' # str | The certification item ID # str | The certification item ID + filters = 'target eq \"SYS.OBJAUTH2\"' # 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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (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: + # Permissions for Entitlement Certification Item + + results = CertificationsApi(api_client).get_identity_certification_item_permissions(certification_id=certification_id, item_id=item_id) + # Below is a request that includes all optional parameters + # results = CertificationsApi(api_client).get_identity_certification_item_permissions(certification_id, item_id, filters, limit, offset, count) + print("The response of CertificationsApi->get_identity_certification_item_permissions:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e) +- path: /certification-tasks + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certifications#get-pending-certification-tasks + source: | + from sailpoint.v3.api.certifications_api import CertificationsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.certification_task import CertificationTask + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + reviewer_identity = 'Ada.1de82e55078344' # str | The ID of reviewer identity. *me* indicates the current user. (optional) # str | The ID of reviewer identity. *me* indicates the current user. (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) + filters = 'type eq \"ADMIN_REASSIGN\"' # 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: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* (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: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* (optional) + try: + # List of Pending Certification Tasks + + results = CertificationsApi(api_client).get_pending_certification_tasks() + # Below is a request that includes all optional parameters + # results = CertificationsApi(api_client).get_pending_certification_tasks(reviewer_identity, limit, offset, count, filters) + print("The response of CertificationsApi->get_pending_certification_tasks:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationsApi->get_pending_certification_tasks: %s\n" % e) +- path: /certifications/{id}/reviewers + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certifications#list-certification-reviewers + source: | + from sailpoint.v3.api.certifications_api import CertificationsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.identity_reference_with_name_and_email import IdentityReferenceWithNameAndEmail + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID + 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) + filters = 'name eq \"Bob\"' # 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: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* (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: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* (optional) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** (optional) + try: + # List of Reviewers for certification + + results = CertificationsApi(api_client).list_certification_reviewers(id=id) + # Below is a request that includes all optional parameters + # results = CertificationsApi(api_client).list_certification_reviewers(id, limit, offset, count, filters, sorters) + print("The response of CertificationsApi->list_certification_reviewers:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationsApi->list_certification_reviewers: %s\n" % e) +- path: /certifications/{id}/access-review-items + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certifications#list-identity-access-review-items + source: | + from sailpoint.v3.api.certifications_api import CertificationsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.access_review_item import AccessReviewItem + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + 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) + filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # 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: **id**: *eq, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (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: **id**: *eq, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + sorters = 'access.name,-accessProfile.sourceName' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (optional) + entitlements = 'identityEntitlement' # str | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional) # str | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional) + access_profiles = 'accessProfile1' # str | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) # str | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) + roles = 'userRole' # str | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) # str | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) + try: + # List of Access Review Items + + results = CertificationsApi(api_client).list_identity_access_review_items(id=id) + # Below is a request that includes all optional parameters + # results = CertificationsApi(api_client).list_identity_access_review_items(id, limit, offset, count, filters, sorters, entitlements, access_profiles, roles) + print("The response of CertificationsApi->list_identity_access_review_items:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationsApi->list_identity_access_review_items: %s\n" % e) +- path: /certifications + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certifications#list-identity-certifications + source: | + from sailpoint.v3.api.certifications_api import CertificationsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.identity_certification_dto import IdentityCertificationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + reviewer_identity = 'me' # str | Reviewer's identity. *me* indicates the current user. (optional) # str | Reviewer's identity. *me* indicates the current user. (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) + filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # 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: **id**: *eq, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (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: **id**: *eq, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) + sorters = 'name,due' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional) + try: + # List Identity Campaign Certifications + + results = CertificationsApi(api_client).list_identity_certifications() + # Below is a request that includes all optional parameters + # results = CertificationsApi(api_client).list_identity_certifications(reviewer_identity, limit, offset, count, filters, sorters) + print("The response of CertificationsApi->list_identity_certifications:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationsApi->list_identity_certifications: %s\n" % e) +- path: /certifications/{id}/decide + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certifications#make-identity-decision + source: | + from sailpoint.v3.api.certifications_api import CertificationsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.identity_certification_dto import IdentityCertificationDto + from sailpoint.v3.models.review_decision import ReviewDecision + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the identity campaign certification on which to make decisions # str | The ID of the identity campaign certification on which to make decisions + review_decision = '''[{id=ef38f94347e94562b5bb8424a56396b5, decision=APPROVE, bulk=true, comments=This user still needs access to this source.}, {id=ef38f94347e94562b5bb8424a56397d8, decision=APPROVE, bulk=true, comments=This user still needs access to this source too.}]''' # List[ReviewDecision] | A non-empty array of decisions to be made. + try: + # Decide on a Certification Item + new_review_decision = ReviewDecision.from_json(review_decision) + results = CertificationsApi(api_client).make_identity_decision(id=id, review_decision=new_review_decision) + # Below is a request that includes all optional parameters + # results = CertificationsApi(api_client).make_identity_decision(id, new_review_decision) + print("The response of CertificationsApi->make_identity_decision:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationsApi->make_identity_decision: %s\n" % e) +- path: /certifications/{id}/reassign + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certifications#reassign-identity-certifications + source: | + from sailpoint.v3.api.certifications_api import CertificationsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.identity_certification_dto import IdentityCertificationDto + from sailpoint.v3.models.review_reassign import ReviewReassign + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + review_reassign = '''{ + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + }''' # ReviewReassign | + try: + # Reassign Identities or Items + new_review_reassign = ReviewReassign.from_json(review_reassign) + results = CertificationsApi(api_client).reassign_identity_certifications(id=id, review_reassign=new_review_reassign) + # Below is a request that includes all optional parameters + # results = CertificationsApi(api_client).reassign_identity_certifications(id, new_review_reassign) + print("The response of CertificationsApi->reassign_identity_certifications:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationsApi->reassign_identity_certifications: %s\n" % e) +- path: /certifications/{id}/sign-off + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certifications#sign-off-identity-certification + source: | + from sailpoint.v3.api.certifications_api import CertificationsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.identity_certification_dto import IdentityCertificationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + try: + # Finalize Identity Certification Decisions + + results = CertificationsApi(api_client).sign_off_identity_certification(id=id) + # Below is a request that includes all optional parameters + # results = CertificationsApi(api_client).sign_off_identity_certification(id) + print("The response of CertificationsApi->sign_off_identity_certification:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationsApi->sign_off_identity_certification: %s\n" % e) +- path: /certifications/{id}/reassign-async + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/certifications#submit-reassign-certs-async + source: | + from sailpoint.v3.api.certifications_api import CertificationsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.certification_task import CertificationTask + from sailpoint.v3.models.review_reassign import ReviewReassign + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID + review_reassign = '''{ + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + }''' # ReviewReassign | + try: + # Reassign Certifications Asynchronously + new_review_reassign = ReviewReassign.from_json(review_reassign) + results = CertificationsApi(api_client).submit_reassign_certs_async(id=id, review_reassign=new_review_reassign) + # Below is a request that includes all optional parameters + # results = CertificationsApi(api_client).submit_reassign_certs_async(id, new_review_reassign) + print("The response of CertificationsApi->submit_reassign_certs_async:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e) +- path: /configuration-hub/object-mappings/{sourceOrg} + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/configuration-hub#create-object-mapping + source: | + from sailpoint.v3.api.configuration_hub_api import ConfigurationHubApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.object_mapping_request import ObjectMappingRequest + from sailpoint.v3.models.object_mapping_response import ObjectMappingResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_org = 'source-org' # str | The name of the source org. # str | The name of the source org. + object_mapping_request = '''{ + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + }''' # ObjectMappingRequest | The object mapping request body. + try: + # Creates an object mapping + new_object_mapping_request = ObjectMappingRequest.from_json(object_mapping_request) + results = ConfigurationHubApi(api_client).create_object_mapping(source_org=source_org, object_mapping_request=new_object_mapping_request) + # Below is a request that includes all optional parameters + # results = ConfigurationHubApi(api_client).create_object_mapping(source_org, new_object_mapping_request) + print("The response of ConfigurationHubApi->create_object_mapping:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ConfigurationHubApi->create_object_mapping: %s\n" % e) +- path: /configuration-hub/object-mappings/{sourceOrg}/bulk-create + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/configuration-hub#create-object-mappings + source: | + from sailpoint.v3.api.configuration_hub_api import ConfigurationHubApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.object_mapping_bulk_create_request import ObjectMappingBulkCreateRequest + from sailpoint.v3.models.object_mapping_bulk_create_response import ObjectMappingBulkCreateResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_org = 'source-org' # str | The name of the source org. # str | The name of the source org. + object_mapping_bulk_create_request = '''{ + "newObjectsMappings" : [ { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + }, { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + } ] + }''' # ObjectMappingBulkCreateRequest | The bulk create object mapping request body. + try: + # Bulk creates object mappings + new_object_mapping_bulk_create_request = ObjectMappingBulkCreateRequest.from_json(object_mapping_bulk_create_request) + results = ConfigurationHubApi(api_client).create_object_mappings(source_org=source_org, object_mapping_bulk_create_request=new_object_mapping_bulk_create_request) + # Below is a request that includes all optional parameters + # results = ConfigurationHubApi(api_client).create_object_mappings(source_org, new_object_mapping_bulk_create_request) + print("The response of ConfigurationHubApi->create_object_mappings:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ConfigurationHubApi->create_object_mappings: %s\n" % e) +- path: /configuration-hub/backups/uploads + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/configuration-hub#create-uploaded-configuration + source: | + from sailpoint.v3.api.configuration_hub_api import ConfigurationHubApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.backup_response import BackupResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported. + name = 'name_example' # str | Name that will be assigned to the uploaded configuration file. # str | Name that will be assigned to the uploaded configuration file. + try: + # Upload a Configuration + + results = ConfigurationHubApi(api_client).create_uploaded_configuration(data=data, name=name) + # Below is a request that includes all optional parameters + # results = ConfigurationHubApi(api_client).create_uploaded_configuration(data, name) + print("The response of ConfigurationHubApi->create_uploaded_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ConfigurationHubApi->create_uploaded_configuration: %s\n" % e) +- path: /configuration-hub/object-mappings/{sourceOrg}/{objectMappingId} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/configuration-hub#delete-object-mapping + source: | + from sailpoint.v3.api.configuration_hub_api import ConfigurationHubApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_org = 'source-org' # str | The name of the source org. # str | The name of the source org. + object_mapping_id = '3d6e0144-963f-4bd6-8d8d-d77b4e507ce4' # str | The id of the object mapping to be deleted. # str | The id of the object mapping to be deleted. + try: + # Deletes an object mapping + + ConfigurationHubApi(api_client).delete_object_mapping(source_org=source_org, object_mapping_id=object_mapping_id) + # Below is a request that includes all optional parameters + # ConfigurationHubApi(api_client).delete_object_mapping(source_org, object_mapping_id) + except Exception as e: + print("Exception when calling ConfigurationHubApi->delete_object_mapping: %s\n" % e) +- path: /configuration-hub/backups/uploads/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/configuration-hub#delete-uploaded-configuration + source: | + from sailpoint.v3.api.configuration_hub_api import ConfigurationHubApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '3d0fe04b-57df-4a46-a83b-8f04b0f9d10b' # str | The id of the uploaded configuration. # str | The id of the uploaded configuration. + try: + # Delete an Uploaded Configuration + + ConfigurationHubApi(api_client).delete_uploaded_configuration(id=id) + # Below is a request that includes all optional parameters + # ConfigurationHubApi(api_client).delete_uploaded_configuration(id) + except Exception as e: + print("Exception when calling ConfigurationHubApi->delete_uploaded_configuration: %s\n" % e) +- path: /configuration-hub/object-mappings/{sourceOrg} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/configuration-hub#get-object-mappings + source: | + from sailpoint.v3.api.configuration_hub_api import ConfigurationHubApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.object_mapping_response import ObjectMappingResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_org = 'source-org' # str | The name of the source org. # str | The name of the source org. + try: + # Gets list of object mappings + + results = ConfigurationHubApi(api_client).get_object_mappings(source_org=source_org) + # Below is a request that includes all optional parameters + # results = ConfigurationHubApi(api_client).get_object_mappings(source_org) + print("The response of ConfigurationHubApi->get_object_mappings:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ConfigurationHubApi->get_object_mappings: %s\n" % e) +- path: /configuration-hub/backups/uploads/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/configuration-hub#get-uploaded-configuration + source: | + from sailpoint.v3.api.configuration_hub_api import ConfigurationHubApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.backup_response import BackupResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '3d0fe04b-57df-4a46-a83b-8f04b0f9d10b' # str | The id of the uploaded configuration. # str | The id of the uploaded configuration. + try: + # Get an Uploaded Configuration + + results = ConfigurationHubApi(api_client).get_uploaded_configuration(id=id) + # Below is a request that includes all optional parameters + # results = ConfigurationHubApi(api_client).get_uploaded_configuration(id) + print("The response of ConfigurationHubApi->get_uploaded_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ConfigurationHubApi->get_uploaded_configuration: %s\n" % e) +- path: /configuration-hub/backups/uploads + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/configuration-hub#list-uploaded-configurations + source: | + from sailpoint.v3.api.configuration_hub_api import ConfigurationHubApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.backup_response import BackupResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + filters = 'status eq \"COMPLETE\"' # 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: **status**: *eq* (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: **status**: *eq* (optional) + try: + # List Uploaded Configurations + + results = ConfigurationHubApi(api_client).list_uploaded_configurations() + # Below is a request that includes all optional parameters + # results = ConfigurationHubApi(api_client).list_uploaded_configurations(filters) + print("The response of ConfigurationHubApi->list_uploaded_configurations:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ConfigurationHubApi->list_uploaded_configurations: %s\n" % e) +- path: /configuration-hub/object-mappings/{sourceOrg}/bulk-patch + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/configuration-hub#update-object-mappings + source: | + from sailpoint.v3.api.configuration_hub_api import ConfigurationHubApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.object_mapping_bulk_patch_request import ObjectMappingBulkPatchRequest + from sailpoint.v3.models.object_mapping_bulk_patch_response import ObjectMappingBulkPatchResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_org = 'source-org' # str | The name of the source org. # str | The name of the source org. + object_mapping_bulk_patch_request = '''{ + "patches" : { + "603b1a61-d03d-4ed1-864f-a508fbd1995d" : [ { + "op" : "replace", + "path" : "/enabled", + "value" : true + } ], + "00bece34-f50d-4227-8878-76f620b5a971" : [ { + "op" : "replace", + "path" : "/targetValue", + "value" : "New Target Value" + } ] + } + }''' # ObjectMappingBulkPatchRequest | The object mapping request body. + try: + # Bulk updates object mappings + new_object_mapping_bulk_patch_request = ObjectMappingBulkPatchRequest.from_json(object_mapping_bulk_patch_request) + results = ConfigurationHubApi(api_client).update_object_mappings(source_org=source_org, object_mapping_bulk_patch_request=new_object_mapping_bulk_patch_request) + # Below is a request that includes all optional parameters + # results = ConfigurationHubApi(api_client).update_object_mappings(source_org, new_object_mapping_bulk_patch_request) + print("The response of ConfigurationHubApi->update_object_mappings:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ConfigurationHubApi->update_object_mappings: %s\n" % e) +- path: /connectors + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/connectors#create-custom-connector + source: | + from sailpoint.v3.api.connectors_api import ConnectorsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.v3_connector_dto import V3ConnectorDto + from sailpoint.v3.models.v3_create_connector_dto import V3CreateConnectorDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + v3_create_connector_dto = '''{ + "name" : "custom connector", + "directConnect" : true, + "className" : "sailpoint.connector.OpenConnectorAdapter", + "type" : "custom connector type", + "status" : "RELEASED" + }''' # V3CreateConnectorDto | + try: + # Create Custom Connector + new_v3_create_connector_dto = V3CreateConnectorDto.from_json(v3_create_connector_dto) + results = ConnectorsApi(api_client).create_custom_connector(v3_create_connector_dto=new_v3_create_connector_dto) + # Below is a request that includes all optional parameters + # results = ConnectorsApi(api_client).create_custom_connector(new_v3_create_connector_dto) + print("The response of ConnectorsApi->create_custom_connector:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ConnectorsApi->create_custom_connector: %s\n" % e) +- path: /connectors/{scriptName} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/connectors#delete-custom-connector + source: | + from sailpoint.v3.api.connectors_api import ConnectorsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + try: + # Delete Connector by Script Name + + ConnectorsApi(api_client).delete_custom_connector(script_name=script_name) + # Below is a request that includes all optional parameters + # ConnectorsApi(api_client).delete_custom_connector(script_name) + except Exception as e: + print("Exception when calling ConnectorsApi->delete_custom_connector: %s\n" % e) +- path: /connectors/{scriptName} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/connectors#get-connector + source: | + from sailpoint.v3.api.connectors_api import ConnectorsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.connector_detail import ConnectorDetail + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + locale = 'de' # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) + try: + # Get Connector by Script Name + + results = ConnectorsApi(api_client).get_connector(script_name=script_name) + # Below is a request that includes all optional parameters + # results = ConnectorsApi(api_client).get_connector(script_name, locale) + print("The response of ConnectorsApi->get_connector:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector: %s\n" % e) +- path: /connectors + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/connectors#get-connector-list + source: | + from sailpoint.v3.api.connectors_api import ConnectorsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.v3_connector_dto import V3ConnectorDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + filters = 'directConnect eq \"true\"' # 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: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (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: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (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) + locale = 'de' # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) + try: + # Get Connector List + + results = ConnectorsApi(api_client).get_connector_list() + # Below is a request that includes all optional parameters + # results = ConnectorsApi(api_client).get_connector_list(filters, limit, offset, count, locale) + print("The response of ConnectorsApi->get_connector_list:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e) +- path: /connectors/{scriptName}/source-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/connectors#get-connector-source-config + source: | + from sailpoint.v3.api.connectors_api import ConnectorsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + try: + # Get Connector Source Configuration + + results = ConnectorsApi(api_client).get_connector_source_config(script_name=script_name) + # Below is a request that includes all optional parameters + # results = ConnectorsApi(api_client).get_connector_source_config(script_name) + print("The response of ConnectorsApi->get_connector_source_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_source_config: %s\n" % e) +- path: /connectors/{scriptName}/source-template + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/connectors#get-connector-source-template + source: | + from sailpoint.v3.api.connectors_api import ConnectorsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + try: + # Get Connector Source Template + + results = ConnectorsApi(api_client).get_connector_source_template(script_name=script_name) + # Below is a request that includes all optional parameters + # results = ConnectorsApi(api_client).get_connector_source_template(script_name) + print("The response of ConnectorsApi->get_connector_source_template:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_source_template: %s\n" % e) +- path: /connectors/{scriptName}/translations/{locale} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/connectors#get-connector-translations + source: | + from sailpoint.v3.api.connectors_api import ConnectorsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + script_name = 'aScriptName' # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + locale = 'de' # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" + try: + # Get Connector Translations + + results = ConnectorsApi(api_client).get_connector_translations(script_name=script_name, locale=locale) + # Below is a request that includes all optional parameters + # results = ConnectorsApi(api_client).get_connector_translations(script_name, locale) + print("The response of ConnectorsApi->get_connector_translations:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ConnectorsApi->get_connector_translations: %s\n" % e) +- path: /connectors/{scriptName}/source-config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/connectors#put-connector-source-config + source: | + from sailpoint.v3.api.connectors_api import ConnectorsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.update_detail import UpdateDetail + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + file = None # bytearray | connector source config xml file # bytearray | connector source config xml file + try: + # Update Connector Source Configuration + + results = ConnectorsApi(api_client).put_connector_source_config(script_name=script_name, file=file) + # Below is a request that includes all optional parameters + # results = ConnectorsApi(api_client).put_connector_source_config(script_name, file) + print("The response of ConnectorsApi->put_connector_source_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ConnectorsApi->put_connector_source_config: %s\n" % e) +- path: /connectors/{scriptName}/source-template + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/connectors#put-connector-source-template + source: | + from sailpoint.v3.api.connectors_api import ConnectorsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.update_detail import UpdateDetail + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + file = None # bytearray | connector source template xml file # bytearray | connector source template xml file + try: + # Update Connector Source Template + + results = ConnectorsApi(api_client).put_connector_source_template(script_name=script_name, file=file) + # Below is a request that includes all optional parameters + # results = ConnectorsApi(api_client).put_connector_source_template(script_name, file) + print("The response of ConnectorsApi->put_connector_source_template:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ConnectorsApi->put_connector_source_template: %s\n" % e) +- path: /connectors/{scriptName}/translations/{locale} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/connectors#put-connector-translations + source: | + from sailpoint.v3.api.connectors_api import ConnectorsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.update_detail import UpdateDetail + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + script_name = 'aScriptName' # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + locale = 'de' # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" + try: + # Update Connector Translations + + results = ConnectorsApi(api_client).put_connector_translations(script_name=script_name, locale=locale) + # Below is a request that includes all optional parameters + # results = ConnectorsApi(api_client).put_connector_translations(script_name, locale) + print("The response of ConnectorsApi->put_connector_translations:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ConnectorsApi->put_connector_translations: %s\n" % e) +- path: /connectors/{scriptName} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/connectors#update-connector + source: | + from sailpoint.v3.api.connectors_api import ConnectorsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.connector_detail import ConnectorDetail + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | A list of connector detail update operations + try: + # Update Connector by Script Name + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ConnectorsApi(api_client).update_connector(script_name=script_name, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = ConnectorsApi(api_client).update_connector(script_name, new_json_patch_operation) + print("The response of ConnectorsApi->update_connector:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ConnectorsApi->update_connector: %s\n" % e) +- path: /auth-org/network-config + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#create-auth-org-network-config + source: | + from sailpoint.v3.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.network_configuration import NetworkConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + network_configuration = '''{ + "range" : [ "1.3.7.2", "255.255.255.252/30" ], + "whitelisted" : true, + "geolocation" : [ "CA", "FR", "HT" ] + }''' # NetworkConfiguration | Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. + try: + # Create security network configuration. + new_network_configuration = NetworkConfiguration.from_json(network_configuration) + results = GlobalTenantSecuritySettingsApi(api_client).create_auth_org_network_config(network_configuration=new_network_configuration) + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).create_auth_org_network_config(new_network_configuration) + print("The response of GlobalTenantSecuritySettingsApi->create_auth_org_network_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->create_auth_org_network_config: %s\n" % e) +- path: /auth-org/lockout-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#get-auth-org-lockout-config + source: | + from sailpoint.v3.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.lockout_configuration import LockoutConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get Auth Org Lockout Configuration. + + results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_lockout_config() + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_lockout_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_lockout_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_lockout_config: %s\n" % e) +- path: /auth-org/network-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#get-auth-org-network-config + source: | + from sailpoint.v3.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.network_configuration import NetworkConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get security network configuration. + + results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_network_config() + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_network_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_network_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_network_config: %s\n" % e) +- path: /auth-org/service-provider-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#get-auth-org-service-provider-config + source: | + from sailpoint.v3.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.service_provider_configuration import ServiceProviderConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get Service Provider Configuration. + + results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_service_provider_config() + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_service_provider_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_service_provider_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_service_provider_config: %s\n" % e) +- path: /auth-org/session-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#get-auth-org-session-config + source: | + from sailpoint.v3.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.session_configuration import SessionConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get Auth Org Session Configuration. + + results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_session_config() + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_session_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_session_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_session_config: %s\n" % e) +- path: /auth-org/lockout-config + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#patch-auth-org-lockout-config + source: | + from sailpoint.v3.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.v3.models.lockout_configuration import LockoutConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + json_patch_operation = '''[{op=replace, path=/maximumAttempts, value=7,}, {op=add, path=/lockoutDuration, value=35}]''' # List[JsonPatchOperation] | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` + try: + # Update Auth Org Lockout Configuration + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_lockout_config(json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_lockout_config(new_json_patch_operation) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_lockout_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_lockout_config: %s\n" % e) +- path: /auth-org/network-config + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#patch-auth-org-network-config + source: | + from sailpoint.v3.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.v3.models.network_configuration import NetworkConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + json_patch_operation = '''[{op=replace, path=/whitelisted, value=false,}, {op=add, path=/geolocation, value=[AF, HN, ES]}]''' # List[JsonPatchOperation] | A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. + try: + # Update security network configuration. + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_network_config(json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_network_config(new_json_patch_operation) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_network_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_network_config: %s\n" % e) +- path: /auth-org/service-provider-config + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#patch-auth-org-service-provider-config + source: | + from sailpoint.v3.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.v3.models.service_provider_configuration import ServiceProviderConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + json_patch_operation = '''[{op=replace, path=/enabled, value=true,}, {op=add, path=/federationProtocolDetails/0/jitConfiguration, value={enabled=true, sourceId=2c9180857377ed2901739c12a2da5ac8, sourceAttributeMappings={firstName=okta.firstName, lastName=okta.lastName, email=okta.email, employeeNumber=okta.employeeNumber}}}]''' # List[JsonPatchOperation] | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) + try: + # Update Service Provider Configuration + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_service_provider_config(json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_service_provider_config(new_json_patch_operation) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_service_provider_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_service_provider_config: %s\n" % e) +- path: /auth-org/session-config + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/global-tenant-security-settings#patch-auth-org-session-config + source: | + from sailpoint.v3.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.v3.models.session_configuration import SessionConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + json_patch_operation = '''[{op=replace, path=/rememberMe, value=true,}, {op=add, path=/maxSessionTime, value=480}]''' # List[JsonPatchOperation] | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` + try: + # Update Auth Org Session Configuration + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_session_config(json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_session_config(new_json_patch_operation) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_session_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_session_config: %s\n" % e) +- path: /identity-profiles + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/identity-profiles#create-identity-profile + source: | + from sailpoint.v3.api.identity_profiles_api import IdentityProfilesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.identity_profile import IdentityProfile + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_profile = '''{ + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2015-05-28T14:07:17Z", + "description" : "My custom flat file profile", + "identityRefreshRequired" : true, + "identityCount" : 8, + "priority" : 10, + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + }, + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "id" : "id12345" + }''' # IdentityProfile | + try: + # Create Identity Profile + new_identity_profile = IdentityProfile.from_json(identity_profile) + results = IdentityProfilesApi(api_client).create_identity_profile(identity_profile=new_identity_profile) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).create_identity_profile(new_identity_profile) + print("The response of IdentityProfilesApi->create_identity_profile:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IdentityProfilesApi->create_identity_profile: %s\n" % e) +- path: /identity-profiles/{identity-profile-id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/identity-profiles#delete-identity-profile + source: | + from sailpoint.v3.api.identity_profiles_api import IdentityProfilesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.task_result_simplified import TaskResultSimplified + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. + try: + # Delete Identity Profile + + results = IdentityProfilesApi(api_client).delete_identity_profile(identity_profile_id=identity_profile_id) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).delete_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->delete_identity_profile:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IdentityProfilesApi->delete_identity_profile: %s\n" % e) +- path: /identity-profiles/bulk-delete + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/identity-profiles#delete-identity-profiles + source: | + from sailpoint.v3.api.identity_profiles_api import IdentityProfilesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.task_result_simplified import TaskResultSimplified + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + request_body = '''['request_body_example']''' # List[str] | Identity Profile bulk delete request body. + try: + # Delete Identity Profiles + new_request_body = RequestBody.from_json(request_body) + results = IdentityProfilesApi(api_client).delete_identity_profiles(request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).delete_identity_profiles(new_request_body) + print("The response of IdentityProfilesApi->delete_identity_profiles:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IdentityProfilesApi->delete_identity_profiles: %s\n" % e) +- path: /identity-profiles/export + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/identity-profiles#export-identity-profiles + source: | + from sailpoint.v3.api.identity_profiles_api import IdentityProfilesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.identity_profile_exported_object import IdentityProfileExportedObject + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + 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) + filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # 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: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (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: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) + sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) + try: + # Export Identity Profiles + + results = IdentityProfilesApi(api_client).export_identity_profiles() + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).export_identity_profiles(limit, offset, count, filters, sorters) + print("The response of IdentityProfilesApi->export_identity_profiles:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e) +- path: /identity-profiles/{identity-profile-id}/default-identity-attribute-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/identity-profiles#get-default-identity-attribute-config + source: | + from sailpoint.v3.api.identity_profiles_api import IdentityProfilesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.identity_attribute_config import IdentityAttributeConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | The Identity Profile ID. # str | The Identity Profile ID. + try: + # Get default Identity Attribute Config + + results = IdentityProfilesApi(api_client).get_default_identity_attribute_config(identity_profile_id=identity_profile_id) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).get_default_identity_attribute_config(identity_profile_id) + print("The response of IdentityProfilesApi->get_default_identity_attribute_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IdentityProfilesApi->get_default_identity_attribute_config: %s\n" % e) +- path: /identity-profiles/{identity-profile-id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/identity-profiles#get-identity-profile + source: | + from sailpoint.v3.api.identity_profiles_api import IdentityProfilesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.identity_profile import IdentityProfile + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID. + try: + # Get Identity Profile + + results = IdentityProfilesApi(api_client).get_identity_profile(identity_profile_id=identity_profile_id) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).get_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->get_identity_profile:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IdentityProfilesApi->get_identity_profile: %s\n" % e) +- path: /identity-profiles/import + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/identity-profiles#import-identity-profiles + source: | + from sailpoint.v3.api.identity_profiles_api import IdentityProfilesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.identity_profile_exported_object import IdentityProfileExportedObject + from sailpoint.v3.models.object_import_result import ObjectImportResult + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_profile_exported_object = '''[sailpoint.v3.IdentityProfileExportedObject()]''' # List[IdentityProfileExportedObject] | Previously exported Identity Profiles. + try: + # Import Identity Profiles + new_identity_profile_exported_object = IdentityProfileExportedObject.from_json(identity_profile_exported_object) + results = IdentityProfilesApi(api_client).import_identity_profiles(identity_profile_exported_object=new_identity_profile_exported_object) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).import_identity_profiles(new_identity_profile_exported_object) + print("The response of IdentityProfilesApi->import_identity_profiles:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IdentityProfilesApi->import_identity_profiles: %s\n" % e) +- path: /identity-profiles + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/identity-profiles#list-identity-profiles + source: | + from sailpoint.v3.api.identity_profiles_api import IdentityProfilesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.identity_profile import IdentityProfile + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + 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) + filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # 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: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (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: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) + sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) + try: + # List Identity Profiles + + results = IdentityProfilesApi(api_client).list_identity_profiles() + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).list_identity_profiles(limit, offset, count, filters, sorters) + print("The response of IdentityProfilesApi->list_identity_profiles:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) +- path: /identity-profiles/identity-preview + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/identity-profiles#show-identity-preview + source: | + from sailpoint.v3.api.identity_profiles_api import IdentityProfilesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.identity_preview_request import IdentityPreviewRequest + from sailpoint.v3.models.identity_preview_response import IdentityPreviewResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_preview_request = '''{ + "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + } + }''' # IdentityPreviewRequest | Identity Preview request body. + try: + # Generate Identity Profile Preview + new_identity_preview_request = IdentityPreviewRequest.from_json(identity_preview_request) + results = IdentityProfilesApi(api_client).show_identity_preview(identity_preview_request=new_identity_preview_request) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).show_identity_preview(new_identity_preview_request) + print("The response of IdentityProfilesApi->show_identity_preview:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IdentityProfilesApi->show_identity_preview: %s\n" % e) +- path: /identity-profiles/{identity-profile-id}/process-identities + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/identity-profiles#sync-identity-profile + source: | + from sailpoint.v3.api.identity_profiles_api import IdentityProfilesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Identity Profile ID to be processed # str | The Identity Profile ID to be processed + try: + # Process identities under profile + + results = IdentityProfilesApi(api_client).sync_identity_profile(identity_profile_id=identity_profile_id) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).sync_identity_profile(identity_profile_id) + print("The response of IdentityProfilesApi->sync_identity_profile:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IdentityProfilesApi->sync_identity_profile: %s\n" % e) +- path: /identity-profiles/{identity-profile-id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/identity-profiles#update-identity-profile + source: | + from sailpoint.v3.api.identity_profiles_api import IdentityProfilesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.identity_profile import IdentityProfile + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID. + json_patch_operation = '''[{op=add, path=/identityAttributeConfig/attributeTransforms/0, value={identityAttributeName=location, transformDefinition={type=accountAttribute, attributes={sourceName=Employees, attributeName=location, sourceId=2c91808878b7d63b0178c66ffcdc4ce4}}}}]''' # List[JsonPatchOperation] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + try: + # Update Identity Profile + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = IdentityProfilesApi(api_client).update_identity_profile(identity_profile_id=identity_profile_id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = IdentityProfilesApi(api_client).update_identity_profile(identity_profile_id, new_json_patch_operation) + print("The response of IdentityProfilesApi->update_identity_profile:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling IdentityProfilesApi->update_identity_profile: %s\n" % e) +- path: /identity-profiles/{identity-profile-id}/lifecycle-states + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/lifecycle-states#create-lifecycle-state + source: | + from sailpoint.v3.api.lifecycle_states_api import LifecycleStatesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.lifecycle_state import LifecycleState + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID. + lifecycle_state = '''{ + "accessProfileIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ], + "emailNotificationOption" : { + "notifyManagers" : true, + "notifySpecificUsers" : true, + "emailAddressList" : [ "test@test.com", "test2@test.com" ], + "notifyAllAdmins" : true + }, + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Lifecycle description", + "accountActions" : [ { + "action" : "ENABLE", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }, { + "action" : "ENABLE", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + } ], + "id" : "id12345", + "identityCount" : 42, + "technicalName" : "Technical Name", + "identityState" : "identityState", + "enabled" : true + }''' # LifecycleState | Lifecycle state to be created. + try: + # Create Lifecycle State + new_lifecycle_state = LifecycleState.from_json(lifecycle_state) + results = LifecycleStatesApi(api_client).create_lifecycle_state(identity_profile_id=identity_profile_id, lifecycle_state=new_lifecycle_state) + # Below is a request that includes all optional parameters + # results = LifecycleStatesApi(api_client).create_lifecycle_state(identity_profile_id, new_lifecycle_state) + print("The response of LifecycleStatesApi->create_lifecycle_state:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling LifecycleStatesApi->create_lifecycle_state: %s\n" % e) +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/lifecycle-states#delete-lifecycle-state + source: | + from sailpoint.v3.api.lifecycle_states_api import LifecycleStatesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.lifecyclestate_deleted import LifecyclestateDeleted + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID. + lifecycle_state_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Lifecycle state ID. # str | Lifecycle state ID. + try: + # Delete Lifecycle State + + results = LifecycleStatesApi(api_client).delete_lifecycle_state(identity_profile_id=identity_profile_id, lifecycle_state_id=lifecycle_state_id) + # Below is a request that includes all optional parameters + # results = LifecycleStatesApi(api_client).delete_lifecycle_state(identity_profile_id, lifecycle_state_id) + print("The response of LifecycleStatesApi->delete_lifecycle_state:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling LifecycleStatesApi->delete_lifecycle_state: %s\n" % e) +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/lifecycle-states#get-lifecycle-state + source: | + from sailpoint.v3.api.lifecycle_states_api import LifecycleStatesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.lifecycle_state import LifecycleState + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID. + lifecycle_state_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Lifecycle state ID. # str | Lifecycle state ID. + try: + # Get Lifecycle State + + results = LifecycleStatesApi(api_client).get_lifecycle_state(identity_profile_id=identity_profile_id, lifecycle_state_id=lifecycle_state_id) + # Below is a request that includes all optional parameters + # results = LifecycleStatesApi(api_client).get_lifecycle_state(identity_profile_id, lifecycle_state_id) + print("The response of LifecycleStatesApi->get_lifecycle_state:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling LifecycleStatesApi->get_lifecycle_state: %s\n" % e) +- path: /identity-profiles/{identity-profile-id}/lifecycle-states + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/lifecycle-states#get-lifecycle-states + source: | + from sailpoint.v3.api.lifecycle_states_api import LifecycleStatesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.lifecycle_state import LifecycleState + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID. + 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) + sorters = 'created,modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + try: + # Lists LifecycleStates + + results = LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id=identity_profile_id) + # Below is a request that includes all optional parameters + # results = LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id, limit, offset, count, sorters) + print("The response of LifecycleStatesApi->get_lifecycle_states:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling LifecycleStatesApi->get_lifecycle_states: %s\n" % e) +- path: /identities/{identity-id}/set-lifecycle-state + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/lifecycle-states#set-lifecycle-state + source: | + from sailpoint.v3.api.lifecycle_states_api import LifecycleStatesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.set_lifecycle_state200_response import SetLifecycleState200Response + from sailpoint.v3.models.set_lifecycle_state_request import SetLifecycleStateRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_id = '2c9180857893f1290178944561990364' # str | ID of the identity to update. # str | ID of the identity to update. + set_lifecycle_state_request = '''sailpoint.v3.SetLifecycleStateRequest()''' # SetLifecycleStateRequest | + try: + # Set Lifecycle State + new_set_lifecycle_state_request = SetLifecycleStateRequest.from_json(set_lifecycle_state_request) + results = LifecycleStatesApi(api_client).set_lifecycle_state(identity_id=identity_id, set_lifecycle_state_request=new_set_lifecycle_state_request) + # Below is a request that includes all optional parameters + # results = LifecycleStatesApi(api_client).set_lifecycle_state(identity_id, new_set_lifecycle_state_request) + print("The response of LifecycleStatesApi->set_lifecycle_state:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling LifecycleStatesApi->set_lifecycle_state: %s\n" % e) +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/lifecycle-states#update-lifecycle-states + source: | + from sailpoint.v3.api.lifecycle_states_api import LifecycleStatesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.v3.models.lifecycle_state import LifecycleState + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID. + lifecycle_state_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Lifecycle state ID. # str | Lifecycle state ID. + json_patch_operation = '''[{op=replace, path=/description, value=Updated description!}, {op=replace, path=/accessProfileIds, value=[2c918087742bab150174407a80f3125e, 2c918087742bab150174407a80f3124f]}, {op=replace, path=/accountActions, value=[{action=ENABLE, sourceIds=[2c9180846a2f82fb016a481c1b1560c5, 2c9180846a2f82fb016a481c1b1560cc]}, {action=DISABLE, sourceIds=[2c91808869a0c9980169a207258513fb]}]}, {op=replace, path=/emailNotificationOption, value={notifyManagers=true, notifyAllAdmins=false, notifySpecificUsers=false, emailAddressList=[]}}]''' # List[JsonPatchOperation] | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption + try: + # Update Lifecycle State + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = LifecycleStatesApi(api_client).update_lifecycle_states(identity_profile_id=identity_profile_id, lifecycle_state_id=lifecycle_state_id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = LifecycleStatesApi(api_client).update_lifecycle_states(identity_profile_id, lifecycle_state_id, new_json_patch_operation) + print("The response of LifecycleStatesApi->update_lifecycle_states:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e) +- path: /mfa/{method}/delete + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-configuration#delete-mfa-config + source: | + from sailpoint.v3.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.mfa_okta_config import MfaOktaConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + method = 'okta-verify' # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + try: + # Delete MFA method configuration + + results = MFAConfigurationApi(api_client).delete_mfa_config(method=method) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).delete_mfa_config(method) + print("The response of MFAConfigurationApi->delete_mfa_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->delete_mfa_config: %s\n" % e) +- path: /mfa/duo-web/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-configuration#get-mfa-duo-config + source: | + from sailpoint.v3.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.mfa_duo_config import MfaDuoConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Configuration of Duo MFA method + + results = MFAConfigurationApi(api_client).get_mfa_duo_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_duo_config() + print("The response of MFAConfigurationApi->get_mfa_duo_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e) +- path: /mfa/kba/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-configuration#get-mfa-kba-config + source: | + from sailpoint.v3.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.kba_question import KbaQuestion + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + all_languages = allLanguages=true # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + try: + # Configuration of KBA MFA method + + results = MFAConfigurationApi(api_client).get_mfa_kba_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) + print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) +- path: /mfa/okta-verify/config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-configuration#get-mfa-okta-config + source: | + from sailpoint.v3.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.mfa_okta_config import MfaOktaConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Configuration of Okta MFA method + + results = MFAConfigurationApi(api_client).get_mfa_okta_config() + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).get_mfa_okta_config() + print("The response of MFAConfigurationApi->get_mfa_okta_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e) +- path: /mfa/duo-web/config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-configuration#set-mfa-duo-config + source: | + from sailpoint.v3.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.mfa_duo_config import MfaDuoConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + mfa_duo_config = '''{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + }''' # MfaDuoConfig | + try: + # Set Duo MFA configuration + new_mfa_duo_config = MfaDuoConfig.from_json(mfa_duo_config) + results = MFAConfigurationApi(api_client).set_mfa_duo_config(mfa_duo_config=new_mfa_duo_config) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfa_duo_config(new_mfa_duo_config) + print("The response of MFAConfigurationApi->set_mfa_duo_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e) +- path: /mfa/okta-verify/config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-configuration#set-mfa-okta-config + source: | + from sailpoint.v3.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.mfa_okta_config import MfaOktaConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + mfa_okta_config = '''{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + }''' # MfaOktaConfig | + try: + # Set Okta MFA configuration + new_mfa_okta_config = MfaOktaConfig.from_json(mfa_okta_config) + results = MFAConfigurationApi(api_client).set_mfa_okta_config(mfa_okta_config=new_mfa_okta_config) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfa_okta_config(new_mfa_okta_config) + print("The response of MFAConfigurationApi->set_mfa_okta_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e) +- path: /mfa/kba/config/answers + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-configuration#set-mfakba-config + source: | + from sailpoint.v3.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.kba_answer_request_item import KbaAnswerRequestItem + from sailpoint.v3.models.kba_answer_response_item import KbaAnswerResponseItem + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | + try: + # Set MFA KBA configuration + new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item) + results = MFAConfigurationApi(api_client).set_mfakba_config(kba_answer_request_item=new_kba_answer_request_item) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) + print("The response of MFAConfigurationApi->set_mfakba_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) +- path: /mfa/{method}/test + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-configuration#test-mfa-config + source: | + from sailpoint.v3.api.mfa_configuration_api import MFAConfigurationApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.mfa_config_test_response import MfaConfigTestResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + method = 'okta-verify' # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + try: + # MFA method's test configuration + + results = MFAConfigurationApi(api_client).test_mfa_config(method=method) + # Below is a request that includes all optional parameters + # results = MFAConfigurationApi(api_client).test_mfa_config(method) + print("The response of MFAConfigurationApi->test_mfa_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e) +- path: /mfa/token/send + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-controller#create-send-token + source: | + from sailpoint.v3.api.mfa_controller_api import MFAControllerApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.send_token_request import SendTokenRequest + from sailpoint.v3.models.send_token_response import SendTokenResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + send_token_request = '''{ + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK" + }''' # SendTokenRequest | + try: + # Create and send user token + new_send_token_request = SendTokenRequest.from_json(send_token_request) + results = MFAControllerApi(api_client).create_send_token(send_token_request=new_send_token_request) + # Below is a request that includes all optional parameters + # results = MFAControllerApi(api_client).create_send_token(new_send_token_request) + print("The response of MFAControllerApi->create_send_token:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAControllerApi->create_send_token: %s\n" % e) +- path: /mfa/{method}/poll + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-controller#ping-verification-status + source: | + from sailpoint.v3.api.mfa_controller_api import MFAControllerApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.verification_poll_request import VerificationPollRequest + from sailpoint.v3.models.verification_response import VerificationResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + method = 'okta-verify' # str | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' # str | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' + verification_poll_request = '''{ + "requestId" : "089899f13a8f4da7824996191587bab9" + }''' # VerificationPollRequest | + try: + # Polling MFA method by VerificationPollRequest + new_verification_poll_request = VerificationPollRequest.from_json(verification_poll_request) + results = MFAControllerApi(api_client).ping_verification_status(method=method, verification_poll_request=new_verification_poll_request) + # Below is a request that includes all optional parameters + # results = MFAControllerApi(api_client).ping_verification_status(method, new_verification_poll_request) + print("The response of MFAControllerApi->ping_verification_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAControllerApi->ping_verification_status: %s\n" % e) +- path: /mfa/duo-web/verify + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-controller#send-duo-verify-request + source: | + from sailpoint.v3.api.mfa_controller_api import MFAControllerApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.duo_verification_request import DuoVerificationRequest + from sailpoint.v3.models.verification_response import VerificationResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + duo_verification_request = '''{ + "signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2", + "userId" : "2c9180947f0ef465017f215cbcfd004b" + }''' # DuoVerificationRequest | + try: + # Verifying authentication via Duo method + new_duo_verification_request = DuoVerificationRequest.from_json(duo_verification_request) + results = MFAControllerApi(api_client).send_duo_verify_request(duo_verification_request=new_duo_verification_request) + # Below is a request that includes all optional parameters + # results = MFAControllerApi(api_client).send_duo_verify_request(new_duo_verification_request) + print("The response of MFAControllerApi->send_duo_verify_request:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAControllerApi->send_duo_verify_request: %s\n" % e) +- path: /mfa/kba/authenticate + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-controller#send-kba-answers + source: | + from sailpoint.v3.api.mfa_controller_api import MFAControllerApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.kba_answer_request_item import KbaAnswerRequestItem + from sailpoint.v3.models.kba_auth_response import KbaAuthResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] | + try: + # Authenticate KBA provided MFA method + new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item) + results = MFAControllerApi(api_client).send_kba_answers(kba_answer_request_item=new_kba_answer_request_item) + # Below is a request that includes all optional parameters + # results = MFAControllerApi(api_client).send_kba_answers(new_kba_answer_request_item) + print("The response of MFAControllerApi->send_kba_answers:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAControllerApi->send_kba_answers: %s\n" % e) +- path: /mfa/okta-verify/verify + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-controller#send-okta-verify-request + source: | + from sailpoint.v3.api.mfa_controller_api import MFAControllerApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.okta_verification_request import OktaVerificationRequest + from sailpoint.v3.models.verification_response import VerificationResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + okta_verification_request = '''{ + "userId" : "example@mail.com" + }''' # OktaVerificationRequest | + try: + # Verifying authentication via Okta method + new_okta_verification_request = OktaVerificationRequest.from_json(okta_verification_request) + results = MFAControllerApi(api_client).send_okta_verify_request(okta_verification_request=new_okta_verification_request) + # Below is a request that includes all optional parameters + # results = MFAControllerApi(api_client).send_okta_verify_request(new_okta_verification_request) + print("The response of MFAControllerApi->send_okta_verify_request:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAControllerApi->send_okta_verify_request: %s\n" % e) +- path: /mfa/token/authenticate + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/mfa-controller#send-token-auth-request + source: | + from sailpoint.v3.api.mfa_controller_api import MFAControllerApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.token_auth_request import TokenAuthRequest + from sailpoint.v3.models.token_auth_response import TokenAuthResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + token_auth_request = '''{ + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK", + "token" : "12345" + }''' # TokenAuthRequest | + try: + # Authenticate Token provided MFA method + new_token_auth_request = TokenAuthRequest.from_json(token_auth_request) + results = MFAControllerApi(api_client).send_token_auth_request(token_auth_request=new_token_auth_request) + # Below is a request that includes all optional parameters + # results = MFAControllerApi(api_client).send_token_auth_request(new_token_auth_request) + print("The response of MFAControllerApi->send_token_auth_request:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling MFAControllerApi->send_token_auth_request: %s\n" % e) +- path: /managed-clients + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#create-managed-client + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_client import ManagedClient + from sailpoint.v3.models.managed_client_request import ManagedClientRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + managed_client_request = '''{ + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" + }''' # ManagedClientRequest | + try: + # Create Managed Client + new_managed_client_request = ManagedClientRequest.from_json(managed_client_request) + results = ManagedClientsApi(api_client).create_managed_client(managed_client_request=new_managed_client_request) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).create_managed_client(new_managed_client_request) + print("The response of ManagedClientsApi->create_managed_client:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->create_managed_client: %s\n" % e) +- path: /managed-clients/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#delete-managed-client + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + try: + # Delete Managed Client + + ManagedClientsApi(api_client).delete_managed_client(id=id) + # Below is a request that includes all optional parameters + # ManagedClientsApi(api_client).delete_managed_client(id) + except Exception as e: + print("Exception when calling ManagedClientsApi->delete_managed_client: %s\n" % e) +- path: /managed-clients/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-client + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_client import ManagedClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + try: + # Get Managed Client + + results = ManagedClientsApi(api_client).get_managed_client(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).get_managed_client(id) + print("The response of ManagedClientsApi->get_managed_client:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_client: %s\n" % e) +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-client-status + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_client_status import ManagedClientStatus + from sailpoint.v3.models.managed_client_type import ManagedClientType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'aClientId' # str | Managed client ID to get status for. # str | Managed client ID to get status for. + type = sailpoint.v3.ManagedClientType() # ManagedClientType | Managed client type to get status for. # ManagedClientType | Managed client type to get status for. + try: + # Get Managed Client Status + + results = ManagedClientsApi(api_client).get_managed_client_status(id=id, type=type) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).get_managed_client_status(id, type) + print("The response of ManagedClientsApi->get_managed_client_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e) +- path: /managed-clients + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#get-managed-clients + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_client import ManagedClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + 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) + 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) + 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) + filters = 'name eq \"client name\"' # 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: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (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: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) + try: + # Get Managed Clients + + results = ManagedClientsApi(api_client).get_managed_clients() + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).get_managed_clients(offset, limit, count, filters) + print("The response of ManagedClientsApi->get_managed_clients:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) +- path: /managed-clients/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clients#update-managed-client + source: | + from sailpoint.v3.api.managed_clients_api import ManagedClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.v3.models.managed_client import ManagedClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID. + json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. + try: + # Update Managed Client + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ManagedClientsApi(api_client).update_managed_client(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = ManagedClientsApi(api_client).update_managed_client(id, new_json_patch_operation) + print("The response of ManagedClientsApi->update_managed_client:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e) +- path: /managed-clusters + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#create-managed-cluster + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_cluster import ManagedCluster + from sailpoint.v3.models.managed_cluster_request import ManagedClusterRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + managed_cluster_request = '''{ + "configuration" : { + "clusterExternalId" : "externalId", + "ccgVersion" : "77.0.0" + }, + "name" : "Managed Cluster Name", + "description" : "A short description of the managed cluster.", + "type" : "idn" + }''' # ManagedClusterRequest | + try: + # Create Create Managed Cluster + new_managed_cluster_request = ManagedClusterRequest.from_json(managed_cluster_request) + results = ManagedClustersApi(api_client).create_managed_cluster(managed_cluster_request=new_managed_cluster_request) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).create_managed_cluster(new_managed_cluster_request) + print("The response of ManagedClustersApi->create_managed_cluster:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->create_managed_cluster: %s\n" % e) +- path: /managed-clusters/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#delete-managed-cluster + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + remove_clients = False # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) + try: + # Delete Managed Cluster + + ManagedClustersApi(api_client).delete_managed_cluster(id=id) + # Below is a request that includes all optional parameters + # ManagedClustersApi(api_client).delete_managed_cluster(id, remove_clients) + except Exception as e: + print("Exception when calling ManagedClustersApi->delete_managed_cluster: %s\n" % e) +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-client-log-configuration + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.client_log_configuration import ClientLogConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of managed cluster to get log configuration for. # str | ID of managed cluster to get log configuration for. + try: + # Get Managed Cluster Log Configuration + + results = ManagedClustersApi(api_client).get_client_log_configuration(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_client_log_configuration(id) + print("The response of ManagedClustersApi->get_client_log_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e) +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-managed-cluster + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_cluster import ManagedCluster + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + try: + # Get Managed Cluster + + results = ManagedClustersApi(api_client).get_managed_cluster(id=id) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_managed_cluster(id) + print("The response of ManagedClustersApi->get_managed_cluster:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e) +- path: /managed-clusters + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#get-managed-clusters + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.managed_cluster import ManagedCluster + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + 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) + 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) + 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) + filters = 'operational eq \"operation\"' # 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: **operational**: *eq* (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: **operational**: *eq* (optional) + try: + # Get Managed Clusters + + results = ManagedClustersApi(api_client).get_managed_clusters() + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) + print("The response of ManagedClustersApi->get_managed_clusters:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#put-client-log-configuration + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.client_log_configuration import ClientLogConfiguration + from sailpoint.v3.models.put_client_log_configuration_request import PutClientLogConfigurationRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of the managed cluster to update the log configuration for. # str | ID of the managed cluster to update the log configuration for. + put_client_log_configuration_request = '''sailpoint.v3.PutClientLogConfigurationRequest()''' # PutClientLogConfigurationRequest | Client log configuration for the given managed cluster. + try: + # Update Managed Cluster Log Configuration + new_put_client_log_configuration_request = PutClientLogConfigurationRequest.from_json(put_client_log_configuration_request) + results = ManagedClustersApi(api_client).put_client_log_configuration(id=id, put_client_log_configuration_request=new_put_client_log_configuration_request) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).put_client_log_configuration(id, new_put_client_log_configuration_request) + print("The response of ManagedClustersApi->put_client_log_configuration:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e) +- path: /managed-clusters/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/managed-clusters#update-managed-cluster + source: | + from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.v3.models.managed_cluster import ManagedCluster + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID. + json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | JSONPatch payload used to update the object. + try: + # Update Managed Cluster + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ManagedClustersApi(api_client).update_managed_cluster(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = ManagedClustersApi(api_client).update_managed_cluster(id, new_json_patch_operation) + print("The response of ManagedClustersApi->update_managed_cluster:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e) +- path: /non-employee-approvals/{id}/approve + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#approve-non-employee-request + source: | + from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.non_employee_approval_decision import NonEmployeeApprovalDecision + from sailpoint.v3.models.non_employee_approval_item import NonEmployeeApprovalItem + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'e136567de87e4d029e60b3c3c55db56d' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) + non_employee_approval_decision = '''{ + "comment" : "Approved by manager" + }''' # NonEmployeeApprovalDecision | + try: + # Approve a Non-Employee Request + new_non_employee_approval_decision = NonEmployeeApprovalDecision.from_json(non_employee_approval_decision) + results = NonEmployeeLifecycleManagementApi(api_client).approve_non_employee_request(id=id, non_employee_approval_decision=new_non_employee_approval_decision) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).approve_non_employee_request(id, new_non_employee_approval_decision) + print("The response of NonEmployeeLifecycleManagementApi->approve_non_employee_request:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->approve_non_employee_request: %s\n" % e) +- path: /non-employee-records + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#create-non-employee-record + source: | + from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.non_employee_record import NonEmployeeRecord + from sailpoint.v3.models.non_employee_request_body import NonEmployeeRequestBody + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + non_employee_request_body = '''{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + }''' # NonEmployeeRequestBody | Non-Employee record creation request body. + try: + # Create Non-Employee Record + new_non_employee_request_body = NonEmployeeRequestBody.from_json(non_employee_request_body) + results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_record(non_employee_request_body=new_non_employee_request_body) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_record(new_non_employee_request_body) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_record:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_record: %s\n" % e) +- path: /non-employee-requests + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#create-non-employee-request + source: | + from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.non_employee_request import NonEmployeeRequest + from sailpoint.v3.models.non_employee_request_body import NonEmployeeRequestBody + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + non_employee_request_body = '''{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + }''' # NonEmployeeRequestBody | Non-Employee creation request body + try: + # Create Non-Employee Request + new_non_employee_request_body = NonEmployeeRequestBody.from_json(non_employee_request_body) + results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_request(non_employee_request_body=new_non_employee_request_body) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_request(new_non_employee_request_body) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_request:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_request: %s\n" % e) +- path: /non-employee-sources + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#create-non-employee-source + source: | + from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.non_employee_source_request_body import NonEmployeeSourceRequestBody + from sailpoint.v3.models.non_employee_source_with_cloud_external_id import NonEmployeeSourceWithCloudExternalId + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + non_employee_source_request_body = '''{ + "owner" : { + "id" : "2c91808570313110017040b06f344ec9" + }, + "managementWorkgroup" : "123299", + "accountManagers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ], + "name" : "Retail", + "description" : "Source description", + "approvers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ] + }''' # NonEmployeeSourceRequestBody | Non-Employee source creation request body. + try: + # Create Non-Employee Source + new_non_employee_source_request_body = NonEmployeeSourceRequestBody.from_json(non_employee_source_request_body) + results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source(non_employee_source_request_body=new_non_employee_source_request_body) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source(new_non_employee_source_request_body) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source: %s\n" % e) +- path: /non-employee-sources/{sourceId}/schema-attributes + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes + source: | + from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute + from sailpoint.v3.models.non_employee_schema_attribute_body import NonEmployeeSchemaAttributeBody + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id + non_employee_schema_attribute_body = '''{ + "helpText" : "The unique identifier for the account", + "label" : "Account Name", + "placeholder" : "Enter a unique user name for this account.", + "type" : "TEXT", + "technicalName" : "account.name", + "required" : true + }''' # NonEmployeeSchemaAttributeBody | + try: + # Create a new Schema Attribute for Non-Employee Source + new_non_employee_schema_attribute_body = NonEmployeeSchemaAttributeBody.from_json(non_employee_schema_attribute_body) + results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source_schema_attributes(source_id=source_id, non_employee_schema_attribute_body=new_non_employee_schema_attribute_body) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source_schema_attributes(source_id, new_non_employee_schema_attribute_body) + print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes: %s\n" % e) +- path: /non-employee-records/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#delete-non-employee-record + source: | + from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-Employee record id (UUID) # str | Non-Employee record id (UUID) + try: + # Delete Non-Employee Record + + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_record(id=id) + # Below is a request that includes all optional parameters + # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_record(id) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_record: %s\n" % e) +- path: /non-employee-records/bulk-delete + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#delete-non-employee-records-in-bulk + source: | + from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.delete_non_employee_records_in_bulk_request import DeleteNonEmployeeRecordsInBulkRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + delete_non_employee_records_in_bulk_request = '''sailpoint.v3.DeleteNonEmployeeRecordsInBulkRequest()''' # DeleteNonEmployeeRecordsInBulkRequest | Non-Employee bulk delete request body. + try: + # Delete Multiple Non-Employee Records + new_delete_non_employee_records_in_bulk_request = DeleteNonEmployeeRecordsInBulkRequest.from_json(delete_non_employee_records_in_bulk_request) + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_records_in_bulk(delete_non_employee_records_in_bulk_request=new_delete_non_employee_records_in_bulk_request) + # Below is a request that includes all optional parameters + # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_records_in_bulk(new_delete_non_employee_records_in_bulk_request) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_records_in_bulk: %s\n" % e) +- path: /non-employee-requests/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#delete-non-employee-request + source: | + from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ac110005-7156-1150-8171-5b292e3e0084' # str | Non-Employee request id in the UUID format # str | Non-Employee request id in the UUID format + try: + # Delete Non-Employee Request + + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_request(id=id) + # Below is a request that includes all optional parameters + # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_request(id) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_request: %s\n" % e) +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#delete-non-employee-schema-attribute + source: | + from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + attribute_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Schema Attribute Id (UUID) # str | The Schema Attribute Id (UUID) + source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id + try: + # Delete a Schema Attribute for Non-Employee Source + + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_schema_attribute(attribute_id=attribute_id, source_id=source_id) + # Below is a request that includes all optional parameters + # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_schema_attribute(attribute_id, source_id) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_schema_attribute: %s\n" % e) +- path: /non-employee-sources/{sourceId} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#delete-non-employee-source + source: | + from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id # str | Source Id + try: + # Delete Non-Employee Source + + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source(source_id=source_id) + # Below is a request that includes all optional parameters + # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source(source_id) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_source: %s\n" % e) +- path: /non-employee-sources/{sourceId}/schema-attributes + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#delete-non-employee-source-schema-attributes + source: | + from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id + try: + # Delete all custom schema attributes for Non-Employee Source + + NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source_schema_attributes(source_id=source_id) + # Below is a request that includes all optional parameters + # NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source_schema_attributes(source_id) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->delete_non_employee_source_schema_attributes: %s\n" % e) +- path: /non-employee-sources/{id}/non-employees/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#export-non-employee-records + source: | + from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id (UUID) # str | Source Id (UUID) + try: + # Exports Non-Employee Records to CSV + + NonEmployeeLifecycleManagementApi(api_client).export_non_employee_records(id=id) + # Below is a request that includes all optional parameters + # NonEmployeeLifecycleManagementApi(api_client).export_non_employee_records(id) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->export_non_employee_records: %s\n" % e) +- path: /non-employee-sources/{id}/schema-attributes-template/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#export-non-employee-source-schema-template + source: | + from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id (UUID) # str | Source Id (UUID) + try: + # Exports Source Schema Template + + NonEmployeeLifecycleManagementApi(api_client).export_non_employee_source_schema_template(id=id) + # Below is a request that includes all optional parameters + # NonEmployeeLifecycleManagementApi(api_client).export_non_employee_source_schema_template(id) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->export_non_employee_source_schema_template: %s\n" % e) +- path: /non-employee-approvals/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#get-non-employee-approval + source: | + from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.non_employee_approval_item_detail import NonEmployeeApprovalItemDetail + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'e136567de87e4d029e60b3c3c55db56d' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) + include_detail = true # bool | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) # bool | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) + try: + # Get a non-employee approval item detail + + results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval(id=id) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval(id, include_detail) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval: %s\n" % e) +- path: /non-employee-approvals/summary/{requested-for} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#get-non-employee-approval-summary + source: | + from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.non_employee_approval_summary import NonEmployeeApprovalSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + requested_for = '2c91808280430dfb0180431a59440460' # str | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. # str | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. + try: + # Get Summary of Non-Employee Approval Requests + + results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval_summary(requested_for=requested_for) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval_summary(requested_for) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary: %s\n" % e) +- path: /non-employee-sources/{id}/non-employee-bulk-upload/status + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#get-non-employee-bulk-upload-status + source: | + from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.non_employee_bulk_upload_status import NonEmployeeBulkUploadStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source ID (UUID) # str | Source ID (UUID) + try: + # Obtain the status of bulk upload on the source + + results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_bulk_upload_status(id=id) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_bulk_upload_status(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status: %s\n" % e) +- path: /non-employee-records/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#get-non-employee-record + source: | + from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.non_employee_record import NonEmployeeRecord + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-Employee record id (UUID) # str | Non-Employee record id (UUID) + try: + # Get a Non-Employee Record + + results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_record(id=id) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_record(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_record:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_record: %s\n" % e) +- path: /non-employee-requests/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#get-non-employee-request + source: | + from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.non_employee_request import NonEmployeeRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ac110005-7156-1150-8171-5b292e3e0084' # str | Non-Employee request id (UUID) # str | Non-Employee request id (UUID) + try: + # Get a Non-Employee Request + + results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request(id=id) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request(id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request: %s\n" % e) +- path: /non-employee-requests/summary/{requested-for} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#get-non-employee-request-summary + source: | + from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.non_employee_request_summary import NonEmployeeRequestSummary + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + requested_for = '2c91808280430dfb0180431a59440460' # str | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. # str | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. + try: + # Get Summary of Non-Employee Requests + + results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request_summary(requested_for=requested_for) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request_summary(requested_for) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request_summary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_request_summary: %s\n" % e) +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#get-non-employee-schema-attribute + source: | + from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + attribute_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Schema Attribute Id (UUID) # str | The Schema Attribute Id (UUID) + source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id + try: + # Get Schema Attribute Non-Employee Source + + results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_schema_attribute(attribute_id=attribute_id, source_id=source_id) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_schema_attribute(attribute_id, source_id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute: %s\n" % e) +- path: /non-employee-sources/{sourceId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#get-non-employee-source + source: | + from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.non_employee_source import NonEmployeeSource + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = '2c91808b7c28b350017c2a2ec5790aa1' # str | Source Id # str | Source Id + try: + # Get a Non-Employee Source + + results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source(source_id=source_id) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source(source_id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source: %s\n" % e) +- path: /non-employee-sources/{sourceId}/schema-attributes + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#get-non-employee-source-schema-attributes + source: | + from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id + try: + # List Schema Attributes Non-Employee Source + + results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source_schema_attributes(source_id=source_id) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source_schema_attributes(source_id) + print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) +- path: /non-employee-sources/{id}/non-employee-bulk-upload + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#import-non-employee-records-in-bulk + source: | + from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.non_employee_bulk_upload_job import NonEmployeeBulkUploadJob + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id (UUID) # str | Source Id (UUID) + data = None # bytearray | # bytearray | + try: + # Imports, or Updates, Non-Employee Records + + results = NonEmployeeLifecycleManagementApi(api_client).import_non_employee_records_in_bulk(id=id, data=data) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).import_non_employee_records_in_bulk(id, data) + print("The response of NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk: %s\n" % e) +- path: /non-employee-approvals + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#list-non-employee-approvals + source: | + from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.non_employee_approval_item import NonEmployeeApprovalItem + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + requested_for = '2c91808280430dfb0180431a59440460' # str | The identity for whom the request was made. *me* indicates the current user. (optional) # str | The identity for whom the request was made. *me* indicates the current user. (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) + filters = 'approvalStatus eq \"Pending\"' # 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: **approvalStatus**: *eq* (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: **approvalStatus**: *eq* (optional) + sorters = 'created' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + try: + # Get List of Non-Employee Approval Requests + + results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approvals() + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approvals(requested_for, limit, offset, count, filters, sorters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approvals:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approvals: %s\n" % e) +- path: /non-employee-records + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#list-non-employee-records + source: | + from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.non_employee_record import NonEmployeeRecord + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + 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) + sorters = 'accountName,sourceId' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) + filters = 'sourceId eq \"2c91808568c529c60168cca6f90c1313\"' # 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* (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* (optional) + try: + # List Non-Employee Records + + results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records() + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records(limit, offset, count, sorters, filters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) +- path: /non-employee-requests + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#list-non-employee-requests + source: | + from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.non_employee_request import NonEmployeeRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + requested_for = 'e136567de87e4d029e60b3c3c55db56d' # str | The identity for whom the request was made. *me* indicates the current user. # str | The identity for whom the request was made. *me* indicates the current user. + 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) + sorters = 'created,approvalStatus' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) + filters = 'sourceId eq \"2c91808568c529c60168cca6f90c1313\"' # 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* (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* (optional) + try: + # List Non-Employee Requests + + results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_requests(requested_for=requested_for) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_requests(requested_for, limit, offset, count, sorters, filters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_requests:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) +- path: /non-employee-sources + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#list-non-employee-sources + source: | + from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.non_employee_source_with_ne_count import NonEmployeeSourceWithNECount + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + 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) + requested_for = 'me' # str | Identity the request was made for. Use 'me' to indicate the current user. (optional) # str | Identity the request was made for. Use 'me' to indicate the current user. (optional) + non_employee_count = False # bool | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to False) # bool | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to False) + sorters = 'name,created' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) + try: + # List Non-Employee Sources + + results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources() + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters) + print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) +- path: /non-employee-records/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#patch-non-employee-record + source: | + from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.v3.models.non_employee_record import NonEmployeeRecord + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-employee record id (UUID) # str | Non-employee record id (UUID) + json_patch_operation = '''[{op=replace, path=/endDate, value=2019-08-23T18:40:35.772Z}]''' # List[JsonPatchOperation] | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + try: + # Patch Non-Employee Record + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_record(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_record(id, new_json_patch_operation) + print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_record:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_record: %s\n" % e) +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#patch-non-employee-schema-attribute + source: | + from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.v3.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + attribute_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Schema Attribute Id (UUID) # str | The Schema Attribute Id (UUID) + source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Source id # str | The Source id + json_patch_operation = '''[{op=replace, path=/label, value={new attribute label=null}}]''' # List[JsonPatchOperation] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'. + try: + # Patch a Schema Attribute for Non-Employee Source + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_schema_attribute(attribute_id=attribute_id, source_id=source_id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_schema_attribute(attribute_id, source_id, new_json_patch_operation) + print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute: %s\n" % e) +- path: /non-employee-sources/{sourceId} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#patch-non-employee-source + source: | + from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.v3.models.non_employee_source import NonEmployeeSource + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + source_id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id # str | Source Id + json_patch_operation = '''[{op=replace, path=/name, value={new name=null}}, {op=replace, path=/approvers, value=[2c91809f703bb37a017040a2fe8748c7, 48b1f463c9e8427db5a5071bd81914b8]}]''' # List[JsonPatchOperation] | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + try: + # Patch a Non-Employee Source + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_source(source_id=source_id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_source(source_id, new_json_patch_operation) + print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_source:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->patch_non_employee_source: %s\n" % e) +- path: /non-employee-approvals/{id}/reject + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#reject-non-employee-request + source: | + from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.non_employee_approval_item import NonEmployeeApprovalItem + from sailpoint.v3.models.non_employee_reject_approval_decision import NonEmployeeRejectApprovalDecision + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'e136567de87e4d029e60b3c3c55db56d' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID) + non_employee_reject_approval_decision = '''{ + "comment" : "approved" + }''' # NonEmployeeRejectApprovalDecision | + try: + # Reject a Non-Employee Request + new_non_employee_reject_approval_decision = NonEmployeeRejectApprovalDecision.from_json(non_employee_reject_approval_decision) + results = NonEmployeeLifecycleManagementApi(api_client).reject_non_employee_request(id=id, non_employee_reject_approval_decision=new_non_employee_reject_approval_decision) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).reject_non_employee_request(id, new_non_employee_reject_approval_decision) + print("The response of NonEmployeeLifecycleManagementApi->reject_non_employee_request:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->reject_non_employee_request: %s\n" % e) +- path: /non-employee-records/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/non-employee-lifecycle-management#update-non-employee-record + source: | + from sailpoint.v3.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.non_employee_record import NonEmployeeRecord + from sailpoint.v3.models.non_employee_request_body import NonEmployeeRequestBody + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | Non-employee record id (UUID) # str | Non-employee record id (UUID) + non_employee_request_body = '''{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + }''' # NonEmployeeRequestBody | Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + try: + # Update Non-Employee Record + new_non_employee_request_body = NonEmployeeRequestBody.from_json(non_employee_request_body) + results = NonEmployeeLifecycleManagementApi(api_client).update_non_employee_record(id=id, non_employee_request_body=new_non_employee_request_body) + # Below is a request that includes all optional parameters + # results = NonEmployeeLifecycleManagementApi(api_client).update_non_employee_record(id, new_non_employee_request_body) + print("The response of NonEmployeeLifecycleManagementApi->update_non_employee_record:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling NonEmployeeLifecycleManagementApi->update_non_employee_record: %s\n" % e) +- path: /oauth-clients + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/o-auth-clients#create-oauth-client + source: | + from sailpoint.v3.api.o_auth_clients_api import OAuthClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.create_o_auth_client_request import CreateOAuthClientRequest + from sailpoint.v3.models.create_o_auth_client_response import CreateOAuthClientResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + create_o_auth_client_request = '''{ + "internal" : false, + "businessName" : "Acme-Solar", + "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", + "refreshTokenValiditySeconds" : 86400, + "type" : "CONFIDENTIAL", + "redirectUris" : [ "http://localhost:12345" ], + "enabled" : true, + "accessType" : "OFFLINE", + "grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ], + "strongAuthSupported" : false, + "homepageUrl" : "http://localhost:12345", + "accessTokenValiditySeconds" : 750, + "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], + "name" : "Demo API Client", + "claimsSupported" : false + }''' # CreateOAuthClientRequest | + try: + # Create OAuth Client + new_create_o_auth_client_request = CreateOAuthClientRequest.from_json(create_o_auth_client_request) + results = OAuthClientsApi(api_client).create_oauth_client(create_o_auth_client_request=new_create_o_auth_client_request) + # Below is a request that includes all optional parameters + # results = OAuthClientsApi(api_client).create_oauth_client(new_create_o_auth_client_request) + print("The response of OAuthClientsApi->create_oauth_client:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling OAuthClientsApi->create_oauth_client: %s\n" % e) +- path: /oauth-clients/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/o-auth-clients#delete-oauth-client + source: | + from sailpoint.v3.api.o_auth_clients_api import OAuthClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id + try: + # Delete OAuth Client + + OAuthClientsApi(api_client).delete_oauth_client(id=id) + # Below is a request that includes all optional parameters + # OAuthClientsApi(api_client).delete_oauth_client(id) + except Exception as e: + print("Exception when calling OAuthClientsApi->delete_oauth_client: %s\n" % e) +- path: /oauth-clients/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/o-auth-clients#get-oauth-client + source: | + from sailpoint.v3.api.o_auth_clients_api import OAuthClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.get_o_auth_client_response import GetOAuthClientResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id + try: + # Get OAuth Client + + results = OAuthClientsApi(api_client).get_oauth_client(id=id) + # Below is a request that includes all optional parameters + # results = OAuthClientsApi(api_client).get_oauth_client(id) + print("The response of OAuthClientsApi->get_oauth_client:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling OAuthClientsApi->get_oauth_client: %s\n" % e) +- path: /oauth-clients + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/o-auth-clients#list-oauth-clients + source: | + from sailpoint.v3.api.o_auth_clients_api import OAuthClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.get_o_auth_client_response import GetOAuthClientResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # 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: **lastUsed**: *le, isnull* (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: **lastUsed**: *le, isnull* (optional) + try: + # List OAuth Clients + + results = OAuthClientsApi(api_client).list_oauth_clients() + # Below is a request that includes all optional parameters + # results = OAuthClientsApi(api_client).list_oauth_clients(filters) + print("The response of OAuthClientsApi->list_oauth_clients:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e) +- path: /oauth-clients/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/o-auth-clients#patch-oauth-client + source: | + from sailpoint.v3.api.o_auth_clients_api import OAuthClientsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.get_o_auth_client_response import GetOAuthClientResponse + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id + json_patch_operation = '''[{op=replace, path=/strongAuthSupported, value=true}, {op=replace, path=/businessName, value=acme-solar}]''' # List[JsonPatchOperation] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported + try: + # Patch OAuth Client + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = OAuthClientsApi(api_client).patch_oauth_client(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = OAuthClientsApi(api_client).patch_oauth_client(id, new_json_patch_operation) + print("The response of OAuthClientsApi->patch_oauth_client:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling OAuthClientsApi->patch_oauth_client: %s\n" % e) +- path: /password-org-config + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-configuration#create-password-org-config + source: | + from sailpoint.v3.api.password_configuration_api import PasswordConfigurationApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.password_org_config import PasswordOrgConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + password_org_config = '''{ + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + }''' # PasswordOrgConfig | + try: + # Create Password Org Config + new_password_org_config = PasswordOrgConfig.from_json(password_org_config) + results = PasswordConfigurationApi(api_client).create_password_org_config(password_org_config=new_password_org_config) + # Below is a request that includes all optional parameters + # results = PasswordConfigurationApi(api_client).create_password_org_config(new_password_org_config) + print("The response of PasswordConfigurationApi->create_password_org_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordConfigurationApi->create_password_org_config: %s\n" % e) +- path: /password-org-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-configuration#get-password-org-config + source: | + from sailpoint.v3.api.password_configuration_api import PasswordConfigurationApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.password_org_config import PasswordOrgConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get Password Org Config + + results = PasswordConfigurationApi(api_client).get_password_org_config() + # Below is a request that includes all optional parameters + # results = PasswordConfigurationApi(api_client).get_password_org_config() + print("The response of PasswordConfigurationApi->get_password_org_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordConfigurationApi->get_password_org_config: %s\n" % e) +- path: /password-org-config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-configuration#put-password-org-config + source: | + from sailpoint.v3.api.password_configuration_api import PasswordConfigurationApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.password_org_config import PasswordOrgConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + password_org_config = '''{ + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + }''' # PasswordOrgConfig | + try: + # Update Password Org Config + new_password_org_config = PasswordOrgConfig.from_json(password_org_config) + results = PasswordConfigurationApi(api_client).put_password_org_config(password_org_config=new_password_org_config) + # Below is a request that includes all optional parameters + # results = PasswordConfigurationApi(api_client).put_password_org_config(new_password_org_config) + print("The response of PasswordConfigurationApi->put_password_org_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordConfigurationApi->put_password_org_config: %s\n" % e) +- path: /password-dictionary + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-dictionary#get-password-dictionary + source: | + from sailpoint.v3.api.password_dictionary_api import PasswordDictionaryApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get Password Dictionary + + results = PasswordDictionaryApi(api_client).get_password_dictionary() + # Below is a request that includes all optional parameters + # results = PasswordDictionaryApi(api_client).get_password_dictionary() + print("The response of PasswordDictionaryApi->get_password_dictionary:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordDictionaryApi->get_password_dictionary: %s\n" % e) +- path: /password-dictionary + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-dictionary#put-password-dictionary + source: | + from sailpoint.v3.api.password_dictionary_api import PasswordDictionaryApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + file = None # bytearray | (optional) # bytearray | (optional) + try: + # Update Password Dictionary + + PasswordDictionaryApi(api_client).put_password_dictionary() + # Below is a request that includes all optional parameters + # PasswordDictionaryApi(api_client).put_password_dictionary(file) + except Exception as e: + print("Exception when calling PasswordDictionaryApi->put_password_dictionary: %s\n" % e) +- path: /password-change-status/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-management#get-password-change-status + source: | + from sailpoint.v3.api.password_management_api import PasswordManagementApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.password_status import PasswordStatus + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '089899f13a8f4da7824996191587bab9' # str | Password change request ID # str | Password change request ID + try: + # Get Password Change Request Status + + results = PasswordManagementApi(api_client).get_password_change_status(id=id) + # Below is a request that includes all optional parameters + # results = PasswordManagementApi(api_client).get_password_change_status(id) + print("The response of PasswordManagementApi->get_password_change_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordManagementApi->get_password_change_status: %s\n" % e) +- path: /query-password-info + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-management#query-password-info + source: | + from sailpoint.v3.api.password_management_api import PasswordManagementApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.password_info import PasswordInfo + from sailpoint.v3.models.password_info_query_dto import PasswordInfoQueryDTO + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + password_info_query_dto = '''{ + "sourceName" : "My-AD", + "userName" : "Abby.Smith" + }''' # PasswordInfoQueryDTO | + try: + # Query Password Info + new_password_info_query_dto = PasswordInfoQueryDto.from_json(password_info_query_dto) + results = PasswordManagementApi(api_client).query_password_info(password_info_query_dto=new_password_info_query_dto) + # Below is a request that includes all optional parameters + # results = PasswordManagementApi(api_client).query_password_info(new_password_info_query_dto) + print("The response of PasswordManagementApi->query_password_info:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordManagementApi->query_password_info: %s\n" % e) +- path: /set-password + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-management#set-password + source: | + from sailpoint.v3.api.password_management_api import PasswordManagementApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.password_change_request import PasswordChangeRequest + from sailpoint.v3.models.password_change_response import PasswordChangeResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + password_change_request = '''{ + "sourceId" : "8a807d4c73c545510173c545d4b60246", + "accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", + "identityId" : "8a807d4c73c545510173c545f0a002ff", + "publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", + "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" + }''' # PasswordChangeRequest | + try: + # Set Identity's Password + new_password_change_request = PasswordChangeRequest.from_json(password_change_request) + results = PasswordManagementApi(api_client).set_password(password_change_request=new_password_change_request) + # Below is a request that includes all optional parameters + # results = PasswordManagementApi(api_client).set_password(new_password_change_request) + print("The response of PasswordManagementApi->set_password:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordManagementApi->set_password: %s\n" % e) +- path: /password-policies + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-policies#create-password-policy + source: | + from sailpoint.v3.api.password_policies_api import PasswordPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.password_policy_v3_dto import PasswordPolicyV3Dto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + password_policy_v3_dto = '''{ + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : "2000-01-23T04:56:07.000+00:00", + "validateAgainstAccountId" : false, + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + }''' # PasswordPolicyV3Dto | + try: + # Create Password Policy + new_password_policy_v3_dto = PasswordPolicyV3Dto.from_json(password_policy_v3_dto) + results = PasswordPoliciesApi(api_client).create_password_policy(password_policy_v3_dto=new_password_policy_v3_dto) + # Below is a request that includes all optional parameters + # results = PasswordPoliciesApi(api_client).create_password_policy(new_password_policy_v3_dto) + print("The response of PasswordPoliciesApi->create_password_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->create_password_policy: %s\n" % e) +- path: /password-policies/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-policies#delete-password-policy + source: | + from sailpoint.v3.api.password_policies_api import PasswordPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ff808081838d9e9d01838da6a03e0002' # str | The ID of password policy to delete. # str | The ID of password policy to delete. + try: + # Delete Password Policy by ID + + PasswordPoliciesApi(api_client).delete_password_policy(id=id) + # Below is a request that includes all optional parameters + # PasswordPoliciesApi(api_client).delete_password_policy(id) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->delete_password_policy: %s\n" % e) +- path: /password-policies/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-policies#get-password-policy-by-id + source: | + from sailpoint.v3.api.password_policies_api import PasswordPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.password_policy_v3_dto import PasswordPolicyV3Dto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ff808081838d9e9d01838da6a03e0005' # str | The ID of password policy to retrieve. # str | The ID of password policy to retrieve. + try: + # Get Password Policy by ID + + results = PasswordPoliciesApi(api_client).get_password_policy_by_id(id=id) + # Below is a request that includes all optional parameters + # results = PasswordPoliciesApi(api_client).get_password_policy_by_id(id) + print("The response of PasswordPoliciesApi->get_password_policy_by_id:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->get_password_policy_by_id: %s\n" % e) +- path: /password-policies + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-policies#list-password-policies + source: | + from sailpoint.v3.api.password_policies_api import PasswordPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.password_policy_v3_dto import PasswordPolicyV3Dto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + 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 Password Policies + + results = PasswordPoliciesApi(api_client).list_password_policies() + # Below is a request that includes all optional parameters + # results = PasswordPoliciesApi(api_client).list_password_policies(limit, offset, count) + print("The response of PasswordPoliciesApi->list_password_policies:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->list_password_policies: %s\n" % e) +- path: /password-policies/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-policies#set-password-policy + source: | + from sailpoint.v3.api.password_policies_api import PasswordPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.password_policy_v3_dto import PasswordPolicyV3Dto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ff808081838d9e9d01838da6a03e0007' # str | The ID of password policy to update. # str | The ID of password policy to update. + password_policy_v3_dto = '''{ + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : "2000-01-23T04:56:07.000+00:00", + "validateAgainstAccountId" : false, + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + }''' # PasswordPolicyV3Dto | + try: + # Update Password Policy by ID + new_password_policy_v3_dto = PasswordPolicyV3Dto.from_json(password_policy_v3_dto) + results = PasswordPoliciesApi(api_client).set_password_policy(id=id, password_policy_v3_dto=new_password_policy_v3_dto) + # Below is a request that includes all optional parameters + # results = PasswordPoliciesApi(api_client).set_password_policy(id, new_password_policy_v3_dto) + print("The response of PasswordPoliciesApi->set_password_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordPoliciesApi->set_password_policy: %s\n" % e) +- path: /password-sync-groups + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-sync-groups#create-password-sync-group + source: | + from sailpoint.v3.api.password_sync_groups_api import PasswordSyncGroupsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.password_sync_group import PasswordSyncGroup + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + password_sync_group = '''{ + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }''' # PasswordSyncGroup | + try: + # Create Password Sync Group + new_password_sync_group = PasswordSyncGroup.from_json(password_sync_group) + results = PasswordSyncGroupsApi(api_client).create_password_sync_group(password_sync_group=new_password_sync_group) + # Below is a request that includes all optional parameters + # results = PasswordSyncGroupsApi(api_client).create_password_sync_group(new_password_sync_group) + print("The response of PasswordSyncGroupsApi->create_password_sync_group:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->create_password_sync_group: %s\n" % e) +- path: /password-sync-groups/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-sync-groups#delete-password-sync-group + source: | + from sailpoint.v3.api.password_sync_groups_api import PasswordSyncGroupsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '6881f631-3bd5-4213-9c75-8e05cc3e35dd' # str | The ID of password sync group to delete. # str | The ID of password sync group to delete. + try: + # Delete Password Sync Group by ID + + PasswordSyncGroupsApi(api_client).delete_password_sync_group(id=id) + # Below is a request that includes all optional parameters + # PasswordSyncGroupsApi(api_client).delete_password_sync_group(id) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->delete_password_sync_group: %s\n" % e) +- path: /password-sync-groups/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-sync-groups#get-password-sync-group + source: | + from sailpoint.v3.api.password_sync_groups_api import PasswordSyncGroupsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.password_sync_group import PasswordSyncGroup + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '6881f631-3bd5-4213-9c75-8e05cc3e35dd' # str | The ID of password sync group to retrieve. # str | The ID of password sync group to retrieve. + try: + # Get Password Sync Group by ID + + results = PasswordSyncGroupsApi(api_client).get_password_sync_group(id=id) + # Below is a request that includes all optional parameters + # results = PasswordSyncGroupsApi(api_client).get_password_sync_group(id) + print("The response of PasswordSyncGroupsApi->get_password_sync_group:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->get_password_sync_group: %s\n" % e) +- path: /password-sync-groups + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-sync-groups#get-password-sync-groups + source: | + from sailpoint.v3.api.password_sync_groups_api import PasswordSyncGroupsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.password_sync_group import PasswordSyncGroup + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + 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: + # Get Password Sync Group List + + results = PasswordSyncGroupsApi(api_client).get_password_sync_groups() + # Below is a request that includes all optional parameters + # results = PasswordSyncGroupsApi(api_client).get_password_sync_groups(limit, offset, count) + print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->get_password_sync_groups: %s\n" % e) +- path: /password-sync-groups/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/password-sync-groups#update-password-sync-group + source: | + from sailpoint.v3.api.password_sync_groups_api import PasswordSyncGroupsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.password_sync_group import PasswordSyncGroup + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '6881f631-3bd5-4213-9c75-8e05cc3e35dd' # str | The ID of password sync group to update. # str | The ID of password sync group to update. + password_sync_group = '''{ + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }''' # PasswordSyncGroup | + try: + # Update Password Sync Group by ID + new_password_sync_group = PasswordSyncGroup.from_json(password_sync_group) + results = PasswordSyncGroupsApi(api_client).update_password_sync_group(id=id, password_sync_group=new_password_sync_group) + # Below is a request that includes all optional parameters + # results = PasswordSyncGroupsApi(api_client).update_password_sync_group(id, new_password_sync_group) + print("The response of PasswordSyncGroupsApi->update_password_sync_group:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PasswordSyncGroupsApi->update_password_sync_group: %s\n" % e) +- path: /personal-access-tokens + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/personal-access-tokens#create-personal-access-token + source: | + from sailpoint.v3.api.personal_access_tokens_api import PersonalAccessTokensApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.create_personal_access_token_request import CreatePersonalAccessTokenRequest + from sailpoint.v3.models.create_personal_access_token_response import CreatePersonalAccessTokenResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + create_personal_access_token_request = '''{ + "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], + "accessTokenValiditySeconds" : 36900, + "name" : "NodeJS Integration" + }''' # CreatePersonalAccessTokenRequest | Name and scope of personal access token. + try: + # Create Personal Access Token + new_create_personal_access_token_request = CreatePersonalAccessTokenRequest.from_json(create_personal_access_token_request) + results = PersonalAccessTokensApi(api_client).create_personal_access_token(create_personal_access_token_request=new_create_personal_access_token_request) + # Below is a request that includes all optional parameters + # results = PersonalAccessTokensApi(api_client).create_personal_access_token(new_create_personal_access_token_request) + print("The response of PersonalAccessTokensApi->create_personal_access_token:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->create_personal_access_token: %s\n" % e) +- path: /personal-access-tokens/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/personal-access-tokens#delete-personal-access-token + source: | + from sailpoint.v3.api.personal_access_tokens_api import PersonalAccessTokensApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The personal access token id # str | The personal access token id + try: + # Delete Personal Access Token + + PersonalAccessTokensApi(api_client).delete_personal_access_token(id=id) + # Below is a request that includes all optional parameters + # PersonalAccessTokensApi(api_client).delete_personal_access_token(id) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->delete_personal_access_token: %s\n" % e) +- path: /personal-access-tokens + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/personal-access-tokens#list-personal-access-tokens + source: | + from sailpoint.v3.api.personal_access_tokens_api import PersonalAccessTokensApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.get_personal_access_token_response import GetPersonalAccessTokenResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + owner_id = '2c9180867b50d088017b554662fb281e' # str | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) # str | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) + filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # 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: **lastUsed**: *le, isnull* (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: **lastUsed**: *le, isnull* (optional) + try: + # List Personal Access Tokens + + results = PersonalAccessTokensApi(api_client).list_personal_access_tokens() + # Below is a request that includes all optional parameters + # results = PersonalAccessTokensApi(api_client).list_personal_access_tokens(owner_id, filters) + print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->list_personal_access_tokens: %s\n" % e) +- path: /personal-access-tokens/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/personal-access-tokens#patch-personal-access-token + source: | + from sailpoint.v3.api.personal_access_tokens_api import PersonalAccessTokensApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.get_personal_access_token_response import GetPersonalAccessTokenResponse + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Personal Access Token id # str | The Personal Access Token id + json_patch_operation = '''[{op=replace, path=/name, value=New name}, {op=replace, path=/scope, value=[sp:scopes:all]}]''' # List[JsonPatchOperation] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope + try: + # Patch Personal Access Token + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = PersonalAccessTokensApi(api_client).patch_personal_access_token(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = PersonalAccessTokensApi(api_client).patch_personal_access_token(id, new_json_patch_operation) + print("The response of PersonalAccessTokensApi->patch_personal_access_token:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PersonalAccessTokensApi->patch_personal_access_token: %s\n" % e) +- path: /public-identities + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/public-identities#get-public-identities + source: | + from sailpoint.v3.api.public_identities_api import PublicIdentitiesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.public_identity import PublicIdentity + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + 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) + filters = 'firstname eq \"John\"' # 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: **id**: *eq, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (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: **id**: *eq, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (optional) + add_core_filters = False # bool | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to False) # bool | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to False) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + try: + # Get list of public identities + + results = PublicIdentitiesApi(api_client).get_public_identities() + # Below is a request that includes all optional parameters + # results = PublicIdentitiesApi(api_client).get_public_identities(limit, offset, count, filters, add_core_filters, sorters) + print("The response of PublicIdentitiesApi->get_public_identities:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PublicIdentitiesApi->get_public_identities: %s\n" % e) +- path: /public-identities-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/public-identities-config#get-public-identity-config + source: | + from sailpoint.v3.api.public_identities_config_api import PublicIdentitiesConfigApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.public_identity_config import PublicIdentityConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get the Public Identities Configuration + + results = PublicIdentitiesConfigApi(api_client).get_public_identity_config() + # Below is a request that includes all optional parameters + # results = PublicIdentitiesConfigApi(api_client).get_public_identity_config() + print("The response of PublicIdentitiesConfigApi->get_public_identity_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PublicIdentitiesConfigApi->get_public_identity_config: %s\n" % e) +- path: /public-identities-config + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/public-identities-config#update-public-identity-config + source: | + from sailpoint.v3.api.public_identities_config_api import PublicIdentitiesConfigApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.public_identity_config import PublicIdentityConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + public_identity_config = '''{ + "modified" : "2018-06-25T20:22:28.104Z", + "attributes" : [ { + "name" : "Country", + "key" : "country" + }, { + "name" : "Country", + "key" : "country" + } ], + "modifiedBy" : { + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }''' # PublicIdentityConfig | + try: + # Update the Public Identities Configuration + new_public_identity_config = PublicIdentityConfig.from_json(public_identity_config) + results = PublicIdentitiesConfigApi(api_client).update_public_identity_config(public_identity_config=new_public_identity_config) + # Below is a request that includes all optional parameters + # results = PublicIdentitiesConfigApi(api_client).update_public_identity_config(new_public_identity_config) + print("The response of PublicIdentitiesConfigApi->update_public_identity_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling PublicIdentitiesConfigApi->update_public_identity_config: %s\n" % e) +- path: /reports/{id}/cancel + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/reports-data-extraction#cancel-report + source: | + from sailpoint.v3.api.reports_data_extraction_api import ReportsDataExtractionApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'a1ed223247144cc29d23c632624b4767' # str | ID of the running Report to cancel # str | ID of the running Report to cancel + try: + # Cancel Report + + ReportsDataExtractionApi(api_client).cancel_report(id=id) + # Below is a request that includes all optional parameters + # ReportsDataExtractionApi(api_client).cancel_report(id) + except Exception as e: + print("Exception when calling ReportsDataExtractionApi->cancel_report: %s\n" % e) +- path: /reports/{taskResultId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/reports-data-extraction#get-report + source: | + from sailpoint.v3.api.reports_data_extraction_api import ReportsDataExtractionApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + task_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Unique identifier of the task result which handled report # str | Unique identifier of the task result which handled report + file_format = 'csv' # str | Output format of the requested report file # str | Output format of the requested report file + name = 'Identities Details Report' # str | preferred Report file name, by default will be used report name from task result. (optional) # str | preferred Report file name, by default will be used report name from task result. (optional) + auditable = False # bool | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to False) # bool | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to False) + try: + # Get Report File + + results = ReportsDataExtractionApi(api_client).get_report(task_result_id=task_result_id, file_format=file_format) + # Below is a request that includes all optional parameters + # results = ReportsDataExtractionApi(api_client).get_report(task_result_id, file_format, name, auditable) + print("The response of ReportsDataExtractionApi->get_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ReportsDataExtractionApi->get_report: %s\n" % e) +- path: /reports/{taskResultId}/result + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/reports-data-extraction#get-report-result + source: | + from sailpoint.v3.api.reports_data_extraction_api import ReportsDataExtractionApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_results import ReportResults + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + task_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Unique identifier of the task result which handled report # str | Unique identifier of the task result which handled report + completed = False # bool | state of task result to apply ordering when results are fetching from the DB (optional) (default to False) # bool | state of task result to apply ordering when results are fetching from the DB (optional) (default to False) + try: + # Get Report Result + + results = ReportsDataExtractionApi(api_client).get_report_result(task_result_id=task_result_id) + # Below is a request that includes all optional parameters + # results = ReportsDataExtractionApi(api_client).get_report_result(task_result_id, completed) + print("The response of ReportsDataExtractionApi->get_report_result:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ReportsDataExtractionApi->get_report_result: %s\n" % e) +- path: /reports/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/reports-data-extraction#start-report + source: | + from sailpoint.v3.api.reports_data_extraction_api import ReportsDataExtractionApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_details import ReportDetails + from sailpoint.v3.models.task_result_details import TaskResultDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_details = '''{ + "reportType" : "ACCOUNTS", + "arguments" : { + "application" : "2c9180897e7742b2017e781782f705b9", + "sourceName" : "Active Directory" + } + }''' # ReportDetails | + try: + # Run Report + new_report_details = ReportDetails.from_json(report_details) + results = ReportsDataExtractionApi(api_client).start_report(report_details=new_report_details) + # Below is a request that includes all optional parameters + # results = ReportsDataExtractionApi(api_client).start_report(new_report_details) + print("The response of ReportsDataExtractionApi->start_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ReportsDataExtractionApi->start_report: %s\n" % e) +- path: /requestable-objects + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/requestable-objects#list-requestable-objects + source: | + from sailpoint.v3.api.requestable_objects_api import RequestableObjectsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.requestable_object import RequestableObject + from sailpoint.v3.models.requestable_object_request_status import RequestableObjectRequestStatus + from sailpoint.v3.models.requestable_object_type import RequestableObjectType + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_id = 'e7eab60924f64aa284175b9fa3309599' # str | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) # str | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) + types = '''[sailpoint.v3.RequestableObjectType()]''' # List[RequestableObjectType] | Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. (optional) + term = 'Finance Role' # str | Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. (optional) # str | Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. (optional) + statuses = '''[sailpoint.v3.RequestableObjectRequestStatus()]''' # List[RequestableObjectRequestStatus] | Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. (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) + filters = 'name sw \"bob\"' # 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: **id**: *eq, in* **name**: *eq, in, sw* (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: **id**: *eq, in* **name**: *eq, in, sw* (optional) + sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + try: + # Requestable Objects List + + results = RequestableObjectsApi(api_client).list_requestable_objects() + # Below is a request that includes all optional parameters + # results = RequestableObjectsApi(api_client).list_requestable_objects(identity_id, types, term, statuses, limit, offset, count, filters, sorters) + print("The response of RequestableObjectsApi->list_requestable_objects:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e) +- path: /roles + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/roles#create-role + source: | + from sailpoint.v3.api.roles_api import RolesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.role import Role + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + role = '''{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "dimensional" : false, + "created" : "2021-03-01T22:32:58.104Z", + "dimensionRefs" : [ { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + }, { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + } ], + "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", + "membership" : { + "identities" : [ { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } ], + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, + "type" : "IDENTITY_LIST" + }, + "enabled" : true, + "revocationRequestConfig" : { + "commentsRequired" : false, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : false + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "legacyMembershipInfo" : { + "type" : "IDENTITY_LIST" + }, + "accessRequestConfig" : { + "commentsRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "name" : "Role 2567", + "modified" : "2021-03-02T20:22:28.104Z", + "accessModelMetadata" : { + "attributes" : [ { + "key" : "iscPrivacy", + "name" : "Privacy", + "multiselect" : false, + "status" : "active", + "type" : "governance", + "objectTypes" : [ "all" ], + "description" : "Specifies the level of privacy associated with an access item.", + "values" : [ { + "value" : "public", + "name" : "Public", + "status" : "active" + } ] + } ] + }, + "id" : "2c918086749d78830174a1a40e121518", + "requestable" : true + }''' # Role | + try: + # Create a Role + new_role = Role.from_json(role) + results = RolesApi(api_client).create_role(role=new_role) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).create_role(new_role) + print("The response of RolesApi->create_role:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RolesApi->create_role: %s\n" % e) +- path: /roles/bulk-delete + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/roles#delete-bulk-roles + source: | + from sailpoint.v3.api.roles_api import RolesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.role_bulk_delete_request import RoleBulkDeleteRequest + from sailpoint.v3.models.task_result_dto import TaskResultDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + role_bulk_delete_request = '''{ + "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + }''' # RoleBulkDeleteRequest | + try: + # Delete Role(s) + new_role_bulk_delete_request = RoleBulkDeleteRequest.from_json(role_bulk_delete_request) + results = RolesApi(api_client).delete_bulk_roles(role_bulk_delete_request=new_role_bulk_delete_request) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).delete_bulk_roles(new_role_bulk_delete_request) + print("The response of RolesApi->delete_bulk_roles:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RolesApi->delete_bulk_roles: %s\n" % e) +- path: /roles/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/roles#delete-role + source: | + from sailpoint.v3.api.roles_api import RolesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role + try: + # Delete a Role + + RolesApi(api_client).delete_role(id=id) + # Below is a request that includes all optional parameters + # RolesApi(api_client).delete_role(id) + except Exception as e: + print("Exception when calling RolesApi->delete_role: %s\n" % e) +- path: /roles/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/roles#get-role + source: | + from sailpoint.v3.api.roles_api import RolesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.role import Role + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role + try: + # Get a Role + + results = RolesApi(api_client).get_role(id=id) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).get_role(id) + print("The response of RolesApi->get_role:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RolesApi->get_role: %s\n" % e) +- path: /roles/{id}/assigned-identities + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/roles#get-role-assigned-identities + source: | + from sailpoint.v3.api.roles_api import RolesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.role_identity import RoleIdentity + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121e121518' # str | ID of the Role for which the assigned Identities are to be listed # str | ID of the Role for which the assigned Identities are to be listed + 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) + filters = 'name sw Joe' # 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: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (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: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) + sorters = 'aliasName,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) + try: + # List Identities assigned a Role + + results = RolesApi(api_client).get_role_assigned_identities(id=id) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).get_role_assigned_identities(id, limit, offset, count, filters, sorters) + print("The response of RolesApi->get_role_assigned_identities:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) +- path: /roles + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/roles#list-roles + source: | + from sailpoint.v3.api.roles_api import RolesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.role import Role + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + for_subadmin = '5168015d32f890ca15812c9180835d2e' # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + 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) + filters = 'requestable eq false' # 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: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (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: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) + sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + include_unsegmented = True # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) + try: + # List Roles + + results = RolesApi(api_client).list_roles() + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).list_roles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) + print("The response of RolesApi->list_roles:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RolesApi->list_roles: %s\n" % e) +- path: /roles/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/roles#patch-role + source: | + from sailpoint.v3.api.roles_api import RolesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.v3.models.role import Role + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c91808a7813090a017814121e121518' # str | ID of the Role to patch # str | ID of the Role to patch + json_patch_operation = '''[{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}]''' # List[JsonPatchOperation] | + try: + # Patch a specified Role + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = RolesApi(api_client).patch_role(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = RolesApi(api_client).patch_role(id, new_json_patch_operation) + print("The response of RolesApi->patch_role:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling RolesApi->patch_role: %s\n" % e) +- path: /sod-policies + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#create-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Create SOD policy + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy) + print("The response of SODPoliciesApi->create_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e) +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#delete-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete. + logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) + try: + # Delete SOD policy by ID + + SODPoliciesApi(api_client).delete_sod_policy(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy(id, logical) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#delete-sod-policy-schedule + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for. + try: + # Delete SOD policy schedule + + SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # SODPoliciesApi(api_client).delete_sod_policy_schedule(id) + except Exception as e: + print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-custom-violation-report + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file. + try: + # Download custom violation report + + results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name) + print("The response of SODPoliciesApi->get_custom_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e) +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-default-violation-report + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download. + try: + # Download violation report + + results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id) + print("The response of SODPoliciesApi->get_default_violation_report:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e) +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-all-report-run-status + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get multi-report run task status + + results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_all_report_run_status() + print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e) +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve. + try: + # Get SOD policy by ID + + results = SODPoliciesApi(api_client).get_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy(id) + print("The response of SODPoliciesApi->get_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-policy-schedule + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve. + try: + # Get SOD policy schedule + + results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_policy_schedule(id) + print("The response of SODPoliciesApi->get_sod_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e) +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-violation-report-run-status + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve. + try: + # Get violation report run status + + results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id) + print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e) +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#get-sod-violation-report-status + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for. + try: + # Get SOD violation report status + + results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).get_sod_violation_report_status(id) + print("The response of SODPoliciesApi->get_sod_violation_report_status:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e) +- path: /sod-policies + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#list-sod-policies + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + 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) + filters = 'id eq \"bc693f07e7b645539626c25954c58554\"' # 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: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (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: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + try: + # List SOD policies + + results = SODPoliciesApi(api_client).list_sod_policies() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) + print("The response of SODPoliciesApi->list_sod_policies:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#patch-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified. + json_patch_operation = '''[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]''' # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + try: + # Patch SOD policy by ID + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SODPoliciesApi(api_client).patch_sod_policy(id=id, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation) + print("The response of SODPoliciesApi->patch_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#put-policy-schedule + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy_schedule import SodPolicySchedule + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule. + sod_policy_schedule = '''{ + "schedule" : { + "hours" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "months" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + }''' # SodPolicySchedule | + try: + # Update SOD Policy schedule + new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule) + results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule) + print("The response of SODPoliciesApi->put_policy_schedule:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e) +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#put-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.sod_policy import SodPolicy + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update. + sod_policy = '''{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + }''' # SodPolicy | + try: + # Update SOD policy by ID + new_sod_policy = SodPolicy.from_json(sod_policy) + results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy) + print("The response of SODPoliciesApi->put_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e) +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#start-evaluate-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Evaluate one policy by ID + + results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id) + print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e) +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#start-sod-all-policies-for-org + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.multi_policy_request import MultiPolicyRequest + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + multi_policy_request = '''{ + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + }''' # MultiPolicyRequest | (optional) + try: + # Runs all policies for org + + results = SODPoliciesApi(api_client).start_sod_all_policies_for_org() + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request) + print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e) +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-policies#start-sod-policy + source: | + from sailpoint.v3.api.sod_policies_api import SODPoliciesApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.report_result_reference import ReportResultReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run. + try: + # Runs SOD policy violation report + + results = SODPoliciesApi(api_client).start_sod_policy(id=id) + # Below is a request that includes all optional parameters + # results = SODPoliciesApi(api_client).start_sod_policy(id) + print("The response of SODPoliciesApi->start_sod_policy:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e) +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-violations#start-predict-sod-violations + source: | + from sailpoint.v3.api.sod_violations_api import SODViolationsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.identity_with_new_access import IdentityWithNewAccess + from sailpoint.v3.models.violation_prediction import ViolationPrediction + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access = '''{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + }''' # IdentityWithNewAccess | + try: + # Predict SOD violations for identity. + new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access) + results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access) + print("The response of SODViolationsApi->start_predict_sod_violations:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e) +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/sod-violations#start-violation-check + source: | + from sailpoint.v3.api.sod_violations_api import SODViolationsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.identity_with_new_access1 import IdentityWithNewAccess1 + from sailpoint.v3.models.sod_violation_check import SodViolationCheck + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + identity_with_new_access1 = '''{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}''' # IdentityWithNewAccess1 | + try: + # Check SOD violations + new_identity_with_new_access1 = IdentityWithNewAccess1.from_json(identity_with_new_access1) + results = SODViolationsApi(api_client).start_violation_check(identity_with_new_access1=new_identity_with_new_access1) + # Below is a request that includes all optional parameters + # results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1) + print("The response of SODViolationsApi->start_violation_check:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e) +- path: /saved-searches + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/saved-search#create-saved-search + source: | + from sailpoint.v3.api.saved_search_api import SavedSearchApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.create_saved_search_request import CreateSavedSearchRequest + from sailpoint.v3.models.saved_search import SavedSearch + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + create_saved_search_request = '''sailpoint.v3.CreateSavedSearchRequest()''' # CreateSavedSearchRequest | The saved search to persist. + try: + # Create a saved search + new_create_saved_search_request = CreateSavedSearchRequest.from_json(create_saved_search_request) + results = SavedSearchApi(api_client).create_saved_search(create_saved_search_request=new_create_saved_search_request) + # Below is a request that includes all optional parameters + # results = SavedSearchApi(api_client).create_saved_search(new_create_saved_search_request) + print("The response of SavedSearchApi->create_saved_search:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SavedSearchApi->create_saved_search: %s\n" % e) +- path: /saved-searches/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/saved-search#delete-saved-search + source: | + from sailpoint.v3.api.saved_search_api import SavedSearchApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + try: + # Delete document by ID + + SavedSearchApi(api_client).delete_saved_search(id=id) + # Below is a request that includes all optional parameters + # SavedSearchApi(api_client).delete_saved_search(id) + except Exception as e: + print("Exception when calling SavedSearchApi->delete_saved_search: %s\n" % e) +- path: /saved-searches/{id}/execute + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/saved-search#execute-saved-search + source: | + from sailpoint.v3.api.saved_search_api import SavedSearchApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.search_arguments import SearchArguments + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + search_arguments = '''{ + "owner" : "", + "recipients" : [ { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" + }''' # SearchArguments | When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. + try: + # Execute a saved search by ID + new_search_arguments = SearchArguments.from_json(search_arguments) + SavedSearchApi(api_client).execute_saved_search(id=id, search_arguments=new_search_arguments) + # Below is a request that includes all optional parameters + # SavedSearchApi(api_client).execute_saved_search(id, new_search_arguments) + except Exception as e: + print("Exception when calling SavedSearchApi->execute_saved_search: %s\n" % e) +- path: /saved-searches/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/saved-search#get-saved-search + source: | + from sailpoint.v3.api.saved_search_api import SavedSearchApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.saved_search import SavedSearch + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + try: + # Return saved search by ID + + results = SavedSearchApi(api_client).get_saved_search(id=id) + # Below is a request that includes all optional parameters + # results = SavedSearchApi(api_client).get_saved_search(id) + print("The response of SavedSearchApi->get_saved_search:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SavedSearchApi->get_saved_search: %s\n" % e) +- path: /saved-searches + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/saved-search#list-saved-searches + source: | + from sailpoint.v3.api.saved_search_api import SavedSearchApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.saved_search import SavedSearch + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + 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) + 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) + 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) + filters = 'owner.id eq \"7a724640-0c17-4ce9-a8c3-4a89738459c8\"' # 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: **owner.id**: *eq* (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: **owner.id**: *eq* (optional) + try: + # A list of Saved Searches + + results = SavedSearchApi(api_client).list_saved_searches() + # Below is a request that includes all optional parameters + # results = SavedSearchApi(api_client).list_saved_searches(offset, limit, count, filters) + print("The response of SavedSearchApi->list_saved_searches:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SavedSearchApi->list_saved_searches: %s\n" % e) +- path: /saved-searches/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/saved-search#put-saved-search + source: | + from sailpoint.v3.api.saved_search_api import SavedSearchApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.saved_search import SavedSearch + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + saved_search = '''{ + "owner" : { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2018-06-25T20:22:28.104Z", + "columns" : { + "identity" : [ { + "field" : "displayName", + "header" : "Display Name" + }, { + "field" : "e-mail", + "header" : "Work Email" + } ] + }, + "query" : "@accounts(disabled:true)", + "description" : "Disabled accounts", + "orderBy" : { + "identity" : [ "lastName", "firstName" ], + "role" : [ "name" ] + }, + "sort" : [ "displayName" ], + "filters" : { + "terms" : [ "account_count", "account_count" ], + "range" : { + "lower" : { + "inclusive" : false, + "value" : "1" + }, + "upper" : { + "inclusive" : false, + "value" : "1" + } + }, + "exclude" : false, + "type" : "RANGE" + }, + "ownerId" : "2c91808568c529c60168cca6f90c1313", + "indices" : [ "identities" ], + "public" : false, + "name" : "Disabled accounts", + "modified" : "2018-06-25T20:22:28.104Z", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "fields" : [ "disabled" ] + }''' # SavedSearch | The saved search to persist. + try: + # Updates an existing saved search + new_saved_search = SavedSearch.from_json(saved_search) + results = SavedSearchApi(api_client).put_saved_search(id=id, saved_search=new_saved_search) + # Below is a request that includes all optional parameters + # results = SavedSearchApi(api_client).put_saved_search(id, new_saved_search) + print("The response of SavedSearchApi->put_saved_search:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SavedSearchApi->put_saved_search: %s\n" % e) +- path: /scheduled-searches + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/scheduled-search#create-scheduled-search + source: | + from sailpoint.v3.api.scheduled_search_api import ScheduledSearchApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.create_scheduled_search_request import CreateScheduledSearchRequest + from sailpoint.v3.models.scheduled_search import ScheduledSearch + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + create_scheduled_search_request = '''{savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]}''' # CreateScheduledSearchRequest | The scheduled search to persist. + try: + # Create a new scheduled search + new_create_scheduled_search_request = CreateScheduledSearchRequest.from_json(create_scheduled_search_request) + results = ScheduledSearchApi(api_client).create_scheduled_search(create_scheduled_search_request=new_create_scheduled_search_request) + # Below is a request that includes all optional parameters + # results = ScheduledSearchApi(api_client).create_scheduled_search(new_create_scheduled_search_request) + print("The response of ScheduledSearchApi->create_scheduled_search:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ScheduledSearchApi->create_scheduled_search: %s\n" % e) +- path: /scheduled-searches/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/scheduled-search#delete-scheduled-search + source: | + from sailpoint.v3.api.scheduled_search_api import ScheduledSearchApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + try: + # Delete a Scheduled Search + + ScheduledSearchApi(api_client).delete_scheduled_search(id=id) + # Below is a request that includes all optional parameters + # ScheduledSearchApi(api_client).delete_scheduled_search(id) + except Exception as e: + print("Exception when calling ScheduledSearchApi->delete_scheduled_search: %s\n" % e) +- path: /scheduled-searches/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/scheduled-search#get-scheduled-search + source: | + from sailpoint.v3.api.scheduled_search_api import ScheduledSearchApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.scheduled_search import ScheduledSearch + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + try: + # Get a Scheduled Search + + results = ScheduledSearchApi(api_client).get_scheduled_search(id=id) + # Below is a request that includes all optional parameters + # results = ScheduledSearchApi(api_client).get_scheduled_search(id) + print("The response of ScheduledSearchApi->get_scheduled_search:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ScheduledSearchApi->get_scheduled_search: %s\n" % e) +- path: /scheduled-searches + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/scheduled-search#list-scheduled-search + source: | + from sailpoint.v3.api.scheduled_search_api import ScheduledSearchApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.scheduled_search import ScheduledSearch + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + 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) + 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) + 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) + filters = 'savedSearchId eq \"6cc0945d-9eeb-4948-9033-72d066e1153e\"' # 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: **owner.id**: *eq* **savedSearchId**: *eq* (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: **owner.id**: *eq* **savedSearchId**: *eq* (optional) + try: + # List scheduled searches + + results = ScheduledSearchApi(api_client).list_scheduled_search() + # Below is a request that includes all optional parameters + # results = ScheduledSearchApi(api_client).list_scheduled_search(offset, limit, count, filters) + print("The response of ScheduledSearchApi->list_scheduled_search:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ScheduledSearchApi->list_scheduled_search: %s\n" % e) +- path: /scheduled-searches/{id}/unsubscribe + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/scheduled-search#unsubscribe-scheduled-search + source: | + from sailpoint.v3.api.scheduled_search_api import ScheduledSearchApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.typed_reference import TypedReference + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + typed_reference = '''{ + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }''' # TypedReference | The recipient to be removed from the scheduled search. + try: + # Unsubscribe a recipient from Scheduled Search + new_typed_reference = TypedReference.from_json(typed_reference) + ScheduledSearchApi(api_client).unsubscribe_scheduled_search(id=id, typed_reference=new_typed_reference) + # Below is a request that includes all optional parameters + # ScheduledSearchApi(api_client).unsubscribe_scheduled_search(id, new_typed_reference) + except Exception as e: + print("Exception when calling ScheduledSearchApi->unsubscribe_scheduled_search: %s\n" % e) +- path: /scheduled-searches/{id} + method: PUT + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/scheduled-search#update-scheduled-search + source: | + from sailpoint.v3.api.scheduled_search_api import ScheduledSearchApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.scheduled_search import ScheduledSearch + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + scheduled_search = '''{ + "owner" : { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "displayQueryDetails" : false, + "created" : "", + "description" : "Daily disabled accounts", + "ownerId" : "2c9180867624cbd7017642d8c8c81f67", + "enabled" : false, + "schedule" : { + "hours" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "months" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "recipients" : [ { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + } ], + "savedSearchId" : "554f1511-f0a1-4744-ab14-599514d3e57c", + "name" : "Daily disabled accounts", + "modified" : "", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "emailEmptyResults" : false + }''' # ScheduledSearch | The scheduled search to persist. + try: + # Update an existing Scheduled Search + new_scheduled_search = ScheduledSearch.from_json(scheduled_search) + results = ScheduledSearchApi(api_client).update_scheduled_search(id=id, scheduled_search=new_scheduled_search) + # Below is a request that includes all optional parameters + # results = ScheduledSearchApi(api_client).update_scheduled_search(id, new_scheduled_search) + print("The response of ScheduledSearchApi->update_scheduled_search:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling ScheduledSearchApi->update_scheduled_search: %s\n" % e) +- path: /search/aggregate + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/search#search-aggregate + source: | + from sailpoint.v3.api.search_api import SearchApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.aggregation_result import AggregationResult + from sailpoint.v3.models.search import Search + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + search = '''{ + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + }''' # Search | + 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) + 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) + 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: + # Perform a Search Query Aggregation + new_search = Search.from_json(search) + results = SearchApi(api_client).search_aggregate(search=new_search) + # Below is a request that includes all optional parameters + # results = SearchApi(api_client).search_aggregate(new_search, offset, limit, count) + print("The response of SearchApi->search_aggregate:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchApi->search_aggregate: %s\n" % e) +- path: /search/count + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/search#search-count + source: | + from sailpoint.v3.api.search_api import SearchApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.search import Search + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + search = '''{ + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + }''' # Search | + try: + # Count Documents Satisfying a Query + new_search = Search.from_json(search) + SearchApi(api_client).search_count(search=new_search) + # Below is a request that includes all optional parameters + # SearchApi(api_client).search_count(new_search) + except Exception as e: + print("Exception when calling SearchApi->search_count: %s\n" % e) +- path: /search/{index}/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/search#search-get + source: | + from sailpoint.v3.api.search_api import SearchApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + index = 'identities' # str | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. # str | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. + id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document. + try: + # Get a Document by ID + + results = SearchApi(api_client).search_get(index=index, id=id) + # Below is a request that includes all optional parameters + # results = SearchApi(api_client).search_get(index, id) + print("The response of SearchApi->search_get:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchApi->search_get: %s\n" % e) +- path: /search + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/search#search-post + source: | + from sailpoint.v3.api.search_api import SearchApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.search import Search + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + search = '''{ + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + }''' # Search | + 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) + 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) + 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: + # Perform Search + new_search = Search.from_json(search) + results = SearchApi(api_client).search_post(search=new_search) + # Below is a request that includes all optional parameters + # results = SearchApi(api_client).search_post(new_search, offset, limit, count) + print("The response of SearchApi->search_post:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchApi->search_post: %s\n" % e) +- path: /accounts/search-attribute-config + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/search-attribute-configuration#create-search-attribute-config + source: | + from sailpoint.v3.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.search_attribute_config import SearchAttributeConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + search_attribute_config = '''{ + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + }''' # SearchAttributeConfig | + try: + # Create Extended Search Attributes + new_search_attribute_config = SearchAttributeConfig.from_json(search_attribute_config) + results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(search_attribute_config=new_search_attribute_config) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(new_search_attribute_config) + print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->create_search_attribute_config: %s\n" % e) +- path: /accounts/search-attribute-config/{name} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/search-attribute-configuration#delete-search-attribute-config + source: | + from sailpoint.v3.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + name = 'newMailAttribute' # str | Name of the extended search attribute configuration to delete. # str | Name of the extended search attribute configuration to delete. + try: + # Delete Extended Search Attribute + + SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name=name) + # Below is a request that includes all optional parameters + # SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->delete_search_attribute_config: %s\n" % e) +- path: /accounts/search-attribute-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/search-attribute-configuration#get-search-attribute-config + source: | + from sailpoint.v3.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.search_attribute_config import SearchAttributeConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + 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) + try: + # List Extended Search Attributes + + results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config() + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(limit, offset) + print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) +- path: /accounts/search-attribute-config/{name} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/search-attribute-configuration#get-single-search-attribute-config + source: | + from sailpoint.v3.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.search_attribute_config import SearchAttributeConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + name = 'newMailAttribute' # str | Name of the extended search attribute configuration to retrieve. # str | Name of the extended search attribute configuration to retrieve. + try: + # Get Extended Search Attribute + + results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name=name) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name) + print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e) +- path: /accounts/search-attribute-config/{name} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/search-attribute-configuration#patch-search-attribute-config + source: | + from sailpoint.v3.api.search_attribute_configuration_api import SearchAttributeConfigurationApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation + from sailpoint.v3.models.search_attribute_config import SearchAttributeConfig + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + name = 'promotedMailAttribute' # str | Name of the search attribute configuration to patch. # str | Name of the search attribute configuration to patch. + json_patch_operation = '''[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}]''' # List[JsonPatchOperation] | + try: + # Update Extended Search Attribute + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name=name, json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name, new_json_patch_operation) + print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SearchAttributeConfigurationApi->patch_search_attribute_config: %s\n" % e) +- path: /segments + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/segments#create-segment + source: | + from sailpoint.v3.api.segments_api import SegmentsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.segment import Segment + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + segment = '''{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" + } + }, + "name" : "segment-xyz", + "modified" : "2020-01-01T00:00:00Z", + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" + }''' # Segment | + try: + # Create Segment + new_segment = Segment.from_json(segment) + results = SegmentsApi(api_client).create_segment(segment=new_segment) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).create_segment(new_segment) + print("The response of SegmentsApi->create_segment:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SegmentsApi->create_segment: %s\n" % e) +- path: /segments/{id} + method: DELETE + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/segments#delete-segment + source: | + from sailpoint.v3.api.segments_api import SegmentsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. + try: + # Delete Segment by ID + + SegmentsApi(api_client).delete_segment(id=id) + # Below is a request that includes all optional parameters + # SegmentsApi(api_client).delete_segment(id) + except Exception as e: + print("Exception when calling SegmentsApi->delete_segment: %s\n" % e) +- path: /segments/{id} + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/segments#get-segment + source: | + from sailpoint.v3.api.segments_api import SegmentsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.segment import Segment + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. + try: + # Get Segment by ID + + results = SegmentsApi(api_client).get_segment(id=id) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).get_segment(id) + print("The response of SegmentsApi->get_segment:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SegmentsApi->get_segment: %s\n" % e) +- path: /segments + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/segments#list-segments + source: | + from sailpoint.v3.api.segments_api import SegmentsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.segment import Segment + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + 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 Segments + + results = SegmentsApi(api_client).list_segments() + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).list_segments(limit, offset, count) + print("The response of SegmentsApi->list_segments:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SegmentsApi->list_segments: %s\n" % e) +- path: /segments/{id} + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/segments#patch-segment + source: | + from sailpoint.v3.api.segments_api import SegmentsApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.segment import Segment + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to modify. # str | The segment ID to modify. + request_body = '''[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]''' # List[object] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + try: + # Update Segment + new_request_body = RequestBody.from_json(request_body) + results = SegmentsApi(api_client).patch_segment(id=id, request_body=new_request_body) + # Below is a request that includes all optional parameters + # results = SegmentsApi(api_client).patch_segment(id, new_request_body) + print("The response of SegmentsApi->patch_segment:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling SegmentsApi->patch_segment: %s\n" % e) +- path: /service-desk-integrations + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v3/methods/service-desk-integration#create-service-desk-integration + source: | + from sailpoint.v3.api.service_desk_integration_api import ServiceDeskIntegrationApi + from sailpoint.v3.api_client import ApiClient + from sailpoint.v3.models.service_desk_integration_dto import ServiceDeskIntegrationDto + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + service_desk_integration_dto = '''{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\nGeben Sie bei Zeit\u00fcberschreitung bei Verbindung die maximal erlaubte Zeitdauer (in Minuten) f\u00fcr die Verbindung von IdentityNow mit der Quelle ein.
Geben Sie die Host-URL der Delinea-SCIM-Serverquelle ein.
Geben Sie den API-Token der Quelle zur Authentifizierung ein. - sectionInfo_AggregationSettings=Geben Sie die Einstellungen f\u00fcr Ihre Aggregation an.
Geben Sie in das Feld Seitengr\u00f6\u00dfe die Anzahl an Kontoeintr\u00e4gen ein, die auf einer einzelnen Seite aggregiert werden sollen, wenn gro\u00dfe Datens\u00e4tze durchlaufen werden.
\n
Geben Sie im Kontofilter die Bedingungen f\u00fcr den Kontofilter an. Beispiel: userName sw "S"
Geben Sie im Gruppenfilter die Gruppenfilterbedingungen an. Beispiel: displayName sw "S". - placeHolder_accAggregation=userName sw "S" - placeHolder_grpAggregation=displayName sw "S" - placeHolder_host=https://{Delinea_SCIM_Server_host}/v2 - docLinkLabel_AuthenticationSettings=Mehr \u00fcber Verbindungseinstellungen - docLinkLabel_Filters=Mehr \u00fcber Konto- und Gruppenfilter - HostURL=Host-URL - ConnectionTimeout=Zeit\u00fcberschreitung bei Verbindung - API_TOKEN=API-Token - JSONPathMapping=JSON-Path-Attribut-Mapping - FilterConditionForAccounts=Kontofilter - FilterConditionForGroups=Gruppenfilter - Page_Size=Seitengr\u00f6\u00dfe - SchemaAttribute=Schema-Attribut - JSONpath=JSON-Pfad - ShortDesc=Das Integrationsmodul IdentityNow f\u00fcr Delinea Secret Server On-Premise bietet die M\u00f6glichkeit einer tiefen Governance f\u00fcr Konten und Gruppen. Es unterst\u00fctzt au\u00dferdem das End-to-End-Lebenszyklus-Management. - connectorMetadata: - type: object - description: A map containing metadata pertinent to the UI to be used - additionalProperties: true - example: - supportedUI: EXTJS - platform: ccg - shortDesc: connector description - status: - type: string - enum: - - DEPRECATED - - DEVELOPMENT - - DEMO - - RELEASED - description: The connector status - example: RELEASED - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:connector-config:read - - idn:connector-config:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/connectors#get-connector - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) - - # Get Connector by Script Name - - try { - Get-Connector -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Get-Connector -ScriptName $ScriptName -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Connector" - Write-Host $_.ErrorDetails - } - delete: - tags: - - Connectors - operationId: deleteCustomConnector - summary: Delete Connector by Script Name - description: Delete a custom connector that using its script name. - parameters: - - name: scriptName - in: path - description: The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - required: true - x-sailpoint-resource-operation-id: getConnectorList - style: simple - explode: false - schema: - type: string - example: aScriptName - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:connector-config:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/connectors#delete-custom-connector - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - - # Delete Connector by Script Name - - try { - Remove-CustomConnector -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Remove-CustomConnector -ScriptName $ScriptName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-CustomConnector" - Write-Host $_.ErrorDetails - } - patch: - tags: - - Connectors - operationId: updateConnector - summary: Update Connector by Script Name - description: | - This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. - - The following fields are patchable: - - - * connectorMetadata - - * applicationXml - - * correlationConfigXml - - * sourceConfigXml - parameters: - - name: scriptName - in: path - description: The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - required: true - x-sailpoint-resource-operation-id: getConnectorList - style: simple - explode: false - schema: - type: string - example: aScriptName - requestBody: - required: true - description: | - A list of connector detail update operations - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml - responses: - '200': - description: A updated Connector Dto object - content: - application/json: - schema: - $ref: '#/paths/~1connectors~1%7BscriptName%7D/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ConnectorDetail.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:connector-config:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/connectors#update-connector - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Connector by Script Name - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-Connector -ScriptName $ScriptName -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-Connector -ScriptName $ScriptName -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Connector" - Write-Host $_.ErrorDetails - } - /connectors: - get: - tags: - - Connectors - operationId: getConnectorList - summary: Get Connector List - description: Fetches list of connectors that have 'RELEASED' status using filtering and pagination. - parameters: - - in: query - name: filters - required: false - schema: - type: string - description: |- - 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: - - **name**: *sw, co* - - **type**: *sw, co, eq* - - **directConnect**: *eq* - - **category**: *eq* - - **features**: *ca* - - **labels**: *ca* - example: directConnect eq "true" - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml - - in: query - name: locale - required: false - schema: - type: string - enum: - - de - - 'no' - - fi - - sv - - ru - - pt - - ko - - zh-TW - - en - - it - - fr - - zh-CN - - hu - - es - - cs - - ja - - pl - - da - - nl - example: de - description: The locale to apply to the config. If no viable locale is given, it will default to "en" - responses: - '200': - description: A Connector Dto object - content: - application/json: - schema: - type: array - items: - title: custom connector response object - type: object - properties: - name: - type: string - description: The connector name - example: name - type: - type: string - description: The connector type - example: ServiceNow - scriptName: - type: string - description: The connector script name - example: servicenow - className: - type: string - nullable: true - description: The connector class name. - example: sailpoint.connector.OpenConnectorAdapter - features: - type: array - description: The list of features supported by the connector - nullable: true - items: - type: string - example: - - PROVISIONING - - SYNC_PROVISIONING - - SEARCH - - UNSTRUCTURED_TARGETS - directConnect: - type: boolean - description: true if the source is a direct connect source - example: true - default: false - connectorMetadata: - type: object - additionalProperties: true - description: A map containing metadata pertinent to the connector - example: - supportedUI: ANGULAR - platform: ccg - shortDesc: connector description - status: - type: string - enum: - - DEPRECATED - - DEVELOPMENT - - DEMO - - RELEASED - description: The connector status - example: RELEASED - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:connector-config:read - - idn:connector-config:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/connectors#get-connector-list - source: | - $Filters = "directConnect eq "true"" # 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: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (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) - $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) - - # Get Connector List - - try { - Get-ConnectorList - - # Below is a request that includes all optional parameters - # Get-ConnectorList -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ConnectorList" - Write-Host $_.ErrorDetails - } - post: - tags: - - Connectors - operationId: createCustomConnector - summary: Create Custom Connector - description: 'Create custom connector. ' - requestBody: - required: true - content: - application/json: - schema: - title: custom connector create request - type: object - required: - - name - - className - properties: - name: - type: string - description: The connector name. Need to be unique per tenant. The name will able be used to derive a url friendly unique scriptname that will be in response. Script name can then be used for all update endpoints - example: custom connector - type: - type: string - description: The connector type. If not specified will be defaulted to 'custom '+name - example: custom connector type - className: - type: string - description: The connector class name. If you are implementing openconnector standard (what is recommended), then this need to be set to sailpoint.connector.OpenConnectorAdapter - example: sailpoint.connector.OpenConnectorAdapter - directConnect: - type: boolean - description: true if the source is a direct connect source - default: true - example: true - status: - type: string - enum: - - DEVELOPMENT - - DEMO - - RELEASED - description: The connector status - example: RELEASED - responses: - '200': - description: A Connector Dto object - content: - application/json: - schema: - $ref: '#/paths/~1connectors/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/V3ConnectorDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:connector-config:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/connectors#create-custom-connector - source: | - $V3CreateConnectorDto = @" - { - "name" : "custom connector", - "directConnect" : true, - "className" : "sailpoint.connector.OpenConnectorAdapter", - "type" : "custom connector type", - "status" : "RELEASED" - } - "@ - - # Create Custom Connector - - try { - $Result = ConvertFrom-JsonToV3CreateConnectorDto -Json $V3CreateConnectorDto - New-CustomConnector -V3CreateConnectorDto $Result - - # Below is a request that includes all optional parameters - # New-CustomConnector -V3CreateConnectorDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-CustomConnector" - Write-Host $_.ErrorDetails - } - /connectors/{scriptName}/source-config: - get: - tags: - - Connectors - operationId: getConnectorSourceConfig - summary: Get Connector Source Configuration - description: 'Fetches a connector''s source config using its script name. ' - parameters: - - name: scriptName - in: path - description: The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - required: true - x-sailpoint-resource-operation-id: getConnectorList - style: simple - explode: false - schema: - type: string - example: aScriptName - responses: - '200': - description: The connector's source template - content: - application/xml: - schema: - type: string - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:connector-config:read - - idn:connector-config:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/connectors#get-connector-source-config - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - - # Get Connector Source Configuration - - try { - Get-ConnectorSourceConfig -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Get-ConnectorSourceConfig -ScriptName $ScriptName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ConnectorSourceConfig" - Write-Host $_.ErrorDetails - } - put: - tags: - - Connectors - operationId: putConnectorSourceConfig - summary: Update Connector Source Configuration - description: 'Update a connector''s source config using its script name. ' - parameters: - - name: scriptName - in: path - description: The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - required: true - x-sailpoint-resource-operation-id: getConnectorList - style: simple - explode: false - schema: - type: string - example: aScriptName - requestBody: - required: true - content: - multipart/form-data: - schema: - type: object - required: - - file - properties: - file: - type: string - description: connector source config xml file - format: binary - responses: - '200': - description: The connector's update detail - content: - application/json: - schema: - type: object - properties: - message: - type: string - description: The detailed message for an update. Typically the relevent error message when status is error. - example: unsupported xsd version, please ensure latest xsd version http://www.sailpoint.com/xsd/sailpoint_form_2_0.xsd is used for source config - scriptName: - type: string - description: The connector script name - example: servicenow - updatedFiles: - type: array - description: The list of updated files supported by the connector - nullable: true - items: - type: string - example: - - pod/org/connectorFiles/testconnector/test1.jar - status: - type: string - enum: - - ERROR - - UPDATED - - UNCHANGED - - SKIPPED - description: The connector update status - example: ERROR - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:connector-config:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/connectors#put-connector-source-config - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - $File = # System.IO.FileInfo | connector source config xml file - - # Update Connector Source Configuration - - try { - Send-ConnectorSourceConfig -ScriptName $ScriptName -File $File - - # Below is a request that includes all optional parameters - # Send-ConnectorSourceConfig -ScriptName $ScriptName -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ConnectorSourceConfig" - Write-Host $_.ErrorDetails - } - /connectors/{scriptName}/translations/{locale}: - get: - tags: - - Connectors - operationId: getConnectorTranslations - summary: Get Connector Translations - description: 'Fetches a connector''s translations using its script name. ' - parameters: - - name: scriptName - in: path - description: The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - required: true - x-sailpoint-resource-operation-id: getConnectorList - style: simple - explode: false - schema: - type: string - example: aScriptName - - name: locale - in: path - required: true - schema: - type: string - enum: - - de - - 'no' - - fi - - sv - - ru - - pt - - ko - - zh-TW - - en - - it - - fr - - zh-CN - - hu - - es - - cs - - ja - - pl - - da - - nl - example: de - description: The locale to apply to the config. If no viable locale is given, it will default to "en" - responses: - '200': - description: The connector's translations - content: - text/plain: - schema: - type: string - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:connector-config:read - - idn:connector-config:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/connectors#get-connector-translations - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" - - # Get Connector Translations - - try { - Get-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale - - # Below is a request that includes all optional parameters - # Get-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ConnectorTranslations" - Write-Host $_.ErrorDetails - } - put: - tags: - - Connectors - operationId: putConnectorTranslations - summary: Update Connector Translations - description: 'Update a connector''s translations using its script name. ' - parameters: - - name: scriptName - in: path - description: The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - required: true - x-sailpoint-resource-operation-id: getConnectorList - style: simple - explode: false - schema: - type: string - example: aScriptName - - name: locale - in: path - required: true - schema: - type: string - enum: - - de - - 'no' - - fi - - sv - - ru - - pt - - ko - - zh-TW - - en - - it - - fr - - zh-CN - - hu - - es - - cs - - ja - - pl - - da - - nl - example: de - description: The locale to apply to the config. If no viable locale is given, it will default to "en" - requestBody: - required: true - content: - multipart/form-data: - schema: - type: object - responses: - '200': - description: The connector's update detail - content: - application/json: - schema: - $ref: '#/paths/~1connectors~1%7BscriptName%7D~1source-config/put/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/UpdateDetail.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:connector-config:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/connectors#put-connector-translations - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" - - # Update Connector Translations - - try { - Send-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale - - # Below is a request that includes all optional parameters - # Send-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ConnectorTranslations" - Write-Host $_.ErrorDetails - } - /connectors/{scriptName}/source-template: - get: - tags: - - Connectors - operationId: getConnectorSourceTemplate - summary: Get Connector Source Template - description: 'Fetches a connector''s source template using its script name. ' - parameters: - - name: scriptName - in: path - description: The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - required: true - x-sailpoint-resource-operation-id: getConnectorList - style: simple - explode: false - schema: - type: string - example: aScriptName - responses: - '200': - description: The connector's source template - content: - application/xml: - schema: - type: string - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:connector-config:read - - idn:connector-config:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/connectors#get-connector-source-template - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - - # Get Connector Source Template - - try { - Get-ConnectorSourceTemplate -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Get-ConnectorSourceTemplate -ScriptName $ScriptName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ConnectorSourceTemplate" - Write-Host $_.ErrorDetails - } - put: - tags: - - Connectors - operationId: putConnectorSourceTemplate - summary: Update Connector Source Template - description: 'Update a connector''s source template using its script name. ' - parameters: - - name: scriptName - in: path - description: The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - required: true - x-sailpoint-resource-operation-id: getConnectorList - style: simple - explode: false - schema: - type: string - example: aScriptName - requestBody: - required: true - content: - multipart/form-data: - schema: - type: object - required: - - file - properties: - file: - type: string - description: connector source template xml file - format: binary - responses: - '200': - description: The connector's update detail - content: - application/json: - schema: - $ref: '#/paths/~1connectors~1%7BscriptName%7D~1source-config/put/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/UpdateDetail.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:connector-config:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/connectors#put-connector-source-template - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - $File = # System.IO.FileInfo | connector source template xml file - - # Update Connector Source Template - - try { - Send-ConnectorSourceTemplate -ScriptName $ScriptName -File $File - - # Below is a request that includes all optional parameters - # Send-ConnectorSourceTemplate -ScriptName $ScriptName -File $File - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ConnectorSourceTemplate" - Write-Host $_.ErrorDetails - } - /identities/{identity-id}/set-lifecycle-state: - post: - operationId: setLifecycleState - tags: - - Lifecycle States - summary: Set Lifecycle State - description: Use this API to set/update an identity's lifecycle state to the one provided and update the corresponding identity profile. - security: - - userAuth: - - idn:identity-lifecycle-state:manage - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: identity-id - description: ID of the identity to update. - required: true - x-sailpoint-resource-operation-id: listIdentities - example: 2c9180857893f1290178944561990364 - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - lifecycleStateId: - type: string - description: ID of the lifecycle state to set. - example: 2c9180877a86e408017a8c19fefe046c - responses: - '200': - description: The request was successfully accepted into the system. - content: - application/json: - schema: - type: object - properties: - accountActivityId: - type: string - example: 2c9180837ab5b716017ab7c6c9ef1e20 - description: ID of the IdentityRequest object that is generated when the workflow launches. To follow the IdentityRequest, you can provide this ID with a [Get Account Activity request](https://developer.sailpoint.com/docs/api/v3/get-account-activity/). The response will contain relevant information about the IdentityRequest, such as its status. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/lifecycle-states#set-lifecycle-state - source: | - $IdentityId = "2c9180857893f1290178944561990364" # String | ID of the identity to update. - $SetLifecycleStateRequest = @" - - "@ - - # Set Lifecycle State - - try { - $Result = ConvertFrom-JsonToSetLifecycleStateRequest -Json $SetLifecycleStateRequest - Set-LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $Result - - # Below is a request that includes all optional parameters - # Set-LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-LifecycleState" - Write-Host $_.ErrorDetails - } - /identity-profiles/{identity-profile-id}/lifecycle-states: - get: - operationId: getLifecycleStates - tags: - - Lifecycle States - summary: Lists LifecycleStates - description: 'Use this endpoint to list all lifecycle states by their associated identity profiles. ' - security: - - userAuth: - - idn:identity-profile-lifecycle-state:read - - applicationAuth: - - idn:identity-profile-lifecycle-state:read - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: identity-profile-id - description: Identity profile ID. - required: true - x-sailpoint-resource-operation-id: listIdentityProfiles - schema: - type: string - example: 2b838de9-db9b-abcf-e646-d4f274ad4238 - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - example: created,modified - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **created, modified** - responses: - '200': - description: List of LifecycleState objects. - content: - application/json: - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Account/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/BaseCommonDto.yaml - - type: object - required: - - technicalName - properties: - enabled: - type: boolean - default: false - example: true - description: Indicates whether the lifecycle state is enabled or disabled. - technicalName: - type: string - example: Technical Name - description: The lifecycle state's technical name. This is for internal use. - description: - type: string - example: Lifecycle description - description: Lifecycle state's description. - identityCount: - type: integer - format: int32 - example: 42 - readOnly: true - description: Number of identities that have the lifecycle state. - emailNotificationOption: - type: object - description: This is used for representing email configuration for a lifecycle state - properties: - notifyManagers: - type: boolean - default: false - example: true - description: If true, then the manager is notified of the lifecycle state change. - notifyAllAdmins: - type: boolean - default: false - example: true - description: If true, then all the admins are notified of the lifecycle state change. - notifySpecificUsers: - type: boolean - default: false - example: true - description: If true, then the users specified in "emailAddressList" below are notified of lifecycle state change. - emailAddressList: - type: array - example: - - test@test.com - - test2@test.com - items: - type: string - description: List of user email addresses. If "notifySpecificUsers" option is true, then these users are notified of lifecycle state change. - accountActions: - type: array - items: - type: object - description: Object for specifying Actions to be performed on a specified list of sources' account. - properties: - action: - example: ENABLE - type: string - description: Describes if action will be enabled or disabled - enum: - - ENABLE - - DISABLE - sourceIds: - type: array - items: - type: string - uniqueItems: true - example: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - description: List of unique source IDs. The sources must have the ENABLE feature or flat file source. See "/sources" endpoint for source features. - accessProfileIds: - type: array - items: - type: string - uniqueItems: true - example: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - description: List of unique access-profile IDs that are associated with the lifecycle state. - identityState: - type: string - nullable: true - example: null - description: The lifecycle state's associated identity state. This field is generally 'null'. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/lifecycle-states#get-lifecycle-states - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - $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) - $Sorters = "created,modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - - # Lists LifecycleStates - - try { - Get-LifecycleStates -IdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Get-LifecycleStates -IdentityProfileId $IdentityProfileId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-LifecycleStates" - Write-Host $_.ErrorDetails - } - post: - operationId: createLifecycleState - tags: - - Lifecycle States - summary: Create Lifecycle State - description: Use this endpoint to create a lifecycle state. - security: - - userAuth: - - idn:identity-profile-lifecycle-state:manage - - applicationAuth: - - idn:identity-profile-lifecycle-state:manage - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: identity-profile-id - description: Identity profile ID. - required: true - x-sailpoint-resource-operation-id: listIdentityProfiles - schema: - type: string - example: 2b838de9-db9b-abcf-e646-d4f274ad4238 - requestBody: - description: Lifecycle state to be created. - required: true - content: - application/json: - schema: - $ref: '#/paths/~1identity-profiles~1%7Bidentity-profile-id%7D~1lifecycle-states/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/LifecycleState.yaml - responses: - '201': - description: Created LifecycleState object. - content: - application/json: - schema: - $ref: '#/paths/~1identity-profiles~1%7Bidentity-profile-id%7D~1lifecycle-states/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/LifecycleState.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/lifecycle-states#create-lifecycle-state - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - $LifecycleState = @" - { - "accessProfileIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ], - "emailNotificationOption" : { - "notifyManagers" : true, - "notifySpecificUsers" : true, - "emailAddressList" : [ "test@test.com", "test2@test.com" ], - "notifyAllAdmins" : true - }, - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Lifecycle description", - "accountActions" : [ { - "action" : "ENABLE", - "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - }, { - "action" : "ENABLE", - "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - } ], - "id" : "id12345", - "identityCount" : 42, - "technicalName" : "Technical Name", - "identityState" : "identityState", - "enabled" : true - } - "@ - - # Create Lifecycle State - - try { - $Result = ConvertFrom-JsonToLifecycleState -Json $LifecycleState - New-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $Result - - # Below is a request that includes all optional parameters - # New-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-LifecycleState" - Write-Host $_.ErrorDetails - } - /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}: - get: - operationId: getLifecycleState - tags: - - Lifecycle States - summary: Get Lifecycle State - description: 'Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. ' - security: - - userAuth: - - idn:identity-profile-lifecycle-state:read - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: identity-profile-id - description: Identity profile ID. - required: true - x-sailpoint-resource-operation-id: listIdentityProfiles - schema: - type: string - example: 2b838de9-db9b-abcf-e646-d4f274ad4238 - - in: path - name: lifecycle-state-id - description: Lifecycle state ID. - required: true - x-sailpoint-resource-operation-id: getLifecycleStates - schema: - type: string - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '200': - description: The requested LifecycleState was successfully retrieved. - content: - application/json: - schema: - $ref: '#/paths/~1identity-profiles~1%7Bidentity-profile-id%7D~1lifecycle-states/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/LifecycleState.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/lifecycle-states#get-lifecycle-state - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. - - # Get Lifecycle State - - try { - Get-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId - - # Below is a request that includes all optional parameters - # Get-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-LifecycleState" - Write-Host $_.ErrorDetails - } - patch: - operationId: updateLifecycleStates - tags: - - Lifecycle States - summary: Update Lifecycle State - description: Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - security: - - userAuth: - - idn:identity-profile-lifecycle-state:manage - - applicationAuth: - - idn:identity-profile-lifecycle-state:manage - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: identity-profile-id - description: Identity profile ID. - required: true - x-sailpoint-resource-operation-id: listIdentityProfiles - schema: - type: string - example: 2b838de9-db9b-abcf-e646-d4f274ad4238 - - in: path - name: lifecycle-state-id - description: Lifecycle state ID. - required: true - x-sailpoint-resource-operation-id: getLifecycleStates - schema: - type: string - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - description: | - A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - The following fields can be updated: - * enabled - * description - * accountActions - * accessProfileIds - * emailNotificationOption - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml - example: - - op: replace - path: /description - value: Updated description! - - op: replace - path: /accessProfileIds - value: - - 2c918087742bab150174407a80f3125e - - 2c918087742bab150174407a80f3124f - - op: replace - path: /accountActions - value: - - action: ENABLE - sourceIds: - - 2c9180846a2f82fb016a481c1b1560c5 - - 2c9180846a2f82fb016a481c1b1560cc - - action: DISABLE - sourceIds: - - 2c91808869a0c9980169a207258513fb - - op: replace - path: /emailNotificationOption - value: - notifyManagers: true - notifyAllAdmins: false - notifySpecificUsers: false - emailAddressList: [] - responses: - '200': - description: The LifecycleState was successfully updated. - content: - application/json: - schema: - $ref: '#/paths/~1identity-profiles~1%7Bidentity-profile-id%7D~1lifecycle-states/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/LifecycleState.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/lifecycle-states#update-lifecycle-states - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Lifecycle State - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-LifecycleStates" - Write-Host $_.ErrorDetails - } - delete: - operationId: deleteLifecycleState - tags: - - Lifecycle States - summary: Delete Lifecycle State - description: 'Use this endpoint to delete the lifecycle state by its ID. ' - security: - - userAuth: - - idn:identity-profile-lifecycle-state:manage - - applicationAuth: - - idn:identity-profile-lifecycle-state:manage - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: identity-profile-id - description: Identity profile ID. - required: true - x-sailpoint-resource-operation-id: listIdentityProfiles - schema: - type: string - example: 2b838de9-db9b-abcf-e646-d4f274ad4238 - - in: path - name: lifecycle-state-id - description: Lifecycle state ID. - required: true - x-sailpoint-resource-operation-id: getLifecycleStates - schema: - type: string - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '202': - description: The request was successfully accepted into the system. - content: - application/json: - schema: - type: object - description: Deleted lifecycle state. - properties: - type: - type: string - description: Deleted lifecycle state's DTO type. - enum: - - LIFECYCLE_STATE - example: LIFECYCLE_STATE - id: - type: string - description: Deleted lifecycle state ID. - example: 12345 - name: - type: string - description: Deleted lifecycle state's display name. - example: Contractor Lifecycle - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/lifecycle-states#delete-lifecycle-state - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. - - # Delete Lifecycle State - - try { - Remove-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId - - # Below is a request that includes all optional parameters - # Remove-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-LifecycleState" - Write-Host $_.ErrorDetails - } - /identity-profiles: - get: - operationId: listIdentityProfiles - tags: - - Identity Profiles - summary: List Identity Profiles - description: Get a list of identity profiles, based on the specified query parameters. - parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml - - in: query - name: filters - required: false - schema: - type: string - example: id eq "ef38f94347e94562b5bb8424a56397d8" - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, ne, ge, gt, in, le, sw* - - **name**: *eq, ne, ge, gt, in, le, sw* - - **priority**: *eq, ne* - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - example: id,name - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** - responses: - '200': - description: List of identity profiles. - content: - application/json: - schema: - type: array - items: - allOf: - - $ref: '#/components/schemas/Account/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/BaseCommonDto.yaml - - type: object - required: - - authoritativeSource - properties: - description: - type: string - description: Identity profile's description. - example: My custom flat file profile - nullable: true - owner: - type: object - description: Identity profile's owner. - nullable: true - properties: - type: - type: string - enum: - - IDENTITY - description: Owner's object type. - example: IDENTITY - id: - type: string - description: Owner's ID. - example: 2c9180835d191a86015d28455b4b232a - name: - type: string - description: Owner's name. - example: William Wilson - priority: - type: integer - format: int64 - description: Identity profile's priority. - example: 10 - authoritativeSource: - type: object - properties: - type: - type: string - enum: - - SOURCE - description: Authoritative source's object type. - example: SOURCE - id: - type: string - description: Authoritative source's ID. - example: 2c9180835d191a86015d28455b4b232a - name: - type: string - description: Authoritative source's name. - example: HR Active Directory - identityRefreshRequired: - type: boolean - default: false - description: Set this value to 'True' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. - example: true - identityCount: - type: integer - description: Number of identities belonging to the identity profile. - format: int32 - example: 8 - identityAttributeConfig: - $ref: '#/components/schemas/IdentityProfile/allOf/1/properties/identityAttributeConfig' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentityAttributeConfig.yaml - identityExceptionReportReference: - $ref: '#/components/schemas/IdentityProfile/allOf/1/properties/identityExceptionReportReference' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentityExceptionReportReference.yaml - hasTimeBasedAttr: - description: Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. - type: boolean - default: false - example: true - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:identity-profile:read - - applicationAuth: - - idn:identity-profile:read - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#list-identity-profiles - source: | - $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) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # 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: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) - - # List Identity Profiles - - try { - Get-IdentityProfiles - - # Below is a request that includes all optional parameters - # Get-IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityProfiles" - Write-Host $_.ErrorDetails - } - post: - operationId: createIdentityProfile - summary: Create Identity Profile - description: 'Creates an identity profile. ' - tags: - - Identity Profiles - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1identity-profiles/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentityProfile.yaml - responses: - '201': - description: Created identity profile. - content: - application/json: - schema: - $ref: '#/paths/~1identity-profiles/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentityProfile.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:identity-profile:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#create-identity-profile - source: | - $IdentityProfile = @" - { - "owner" : { - "name" : "William Wilson", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "IDENTITY" - }, - "identityExceptionReportReference" : { - "reportName" : "My annual report", - "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" - }, - "authoritativeSource" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - }, - "hasTimeBasedAttr" : true, - "created" : "2015-05-28T14:07:17Z", - "description" : "My custom flat file profile", - "identityRefreshRequired" : true, - "identityCount" : 8, - "priority" : 10, - "identityAttributeConfig" : { - "attributeTransforms" : [ { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - }, { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - } ], - "enabled" : true - }, - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "id" : "id12345" - } - "@ - - # Create Identity Profile - - try { - $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile - New-IdentityProfile -IdentityProfile $Result - - # Below is a request that includes all optional parameters - # New-IdentityProfile -IdentityProfile $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-IdentityProfile" - Write-Host $_.ErrorDetails - } - /identity-profiles/bulk-delete: - post: - operationId: deleteIdentityProfiles - tags: - - Identity Profiles - summary: Delete Identity Profiles - description: |- - This deletes multiple Identity Profiles via a list of supplied IDs. - - On success, this endpoint will return a reference to the bulk delete task result. - - The following rights are required to access this endpoint: idn:identity-profile:delete - requestBody: - description: Identity Profile bulk delete request body. - required: true - content: - application/json: - schema: - description: List of Identity Profile IDs to delete. - type: array - items: - type: string - example: - - 2c9180867b2a34e0017b3078d60b0699 - - 2c9180867b2a34e0017b3078d60b0698 - responses: - '202': - description: Accepted - Returns a TaskResult object referencing the bulk delete job created. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: Task identifier - example: ff8081814d977c21014da056804a0af3 - name: - type: string - description: Task name - example: Background Object Terminator c8f030f2-b1a6-4e33-99e8-6935bc18735d - description: - type: string - description: Task description - example: Generic task for terminating data in the overlay, used by the TerminationService. - launcher: - type: string - description: User or process who launched the task - example: support - completed: - type: string - format: date-time - description: Date time of completion - example: Mon Aug 21 14:57:39 CDT 2023 - launched: - type: string - format: date-time - description: Date time when the task was launched - example: Mon Aug 21 14:55:39 CDT 2023 - completionStatus: - type: string - enum: - - Success - - Warning - - Error - - Terminated - - TempError - description: Task result status - example: Success - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:identity-profile:delete - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#delete-identity-profiles - source: | - $RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request body. - $RequestBody = @""@ - - - # Delete Identity Profiles - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Remove-IdentityProfiles -RequestBody $Result - - # Below is a request that includes all optional parameters - # Remove-IdentityProfiles -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-IdentityProfiles" - Write-Host $_.ErrorDetails - } - /identity-profiles/export: - get: - operationId: exportIdentityProfiles - tags: - - Identity Profiles - summary: Export Identity Profiles - description: This exports existing identity profiles in the format specified by the sp-config service. - parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml - - in: query - name: filters - required: false - schema: - type: string - example: id eq "ef38f94347e94562b5bb8424a56397d8" - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, ne* - - **name**: *eq, ne* - - **priority**: *eq, ne* - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - example: id,name - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **id, name, priority** - responses: - '200': - description: List of export objects with identity profiles. - content: - application/json: - schema: - type: array - items: - type: object - description: Identity profile exported object. - properties: - version: - type: integer - example: 1 - description: Version or object from the target service. - format: int32 - self: - type: object - description: Self block for exported object. - properties: - type: - type: string - description: Exported object's DTO type. - enum: - - ACCESS_PROFILE - - ACCESS_REQUEST_CONFIG - - ATTR_SYNC_SOURCE_CONFIG - - AUTH_ORG - - CAMPAIGN_FILTER - - FORM_DEFINITION - - GOVERNANCE_GROUP - - IDENTITY_OBJECT_CONFIG - - IDENTITY_PROFILE - - LIFECYCLE_STATE - - NOTIFICATION_TEMPLATE - - PASSWORD_POLICY - - PASSWORD_SYNC_GROUP - - PUBLIC_IDENTITIES_CONFIG - - ROLE - - RULE - - SEGMENT - - SERVICE_DESK_INTEGRATION - - SOD_POLICY - - SOURCE - - TAG - - TRANSFORM - - TRIGGER_SUBSCRIPTION - - WORKFLOW - example: SOURCE - id: - type: string - description: Exported object's ID. - example: 2c9180835d191a86015d28455b4b232a - name: - type: string - description: Exported object's display name. - example: HR Active Directory - object: - $ref: '#/paths/~1identity-profiles/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentityProfile.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:identity-profile:read - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#export-identity-profiles - source: | - $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) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # 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: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) - - # Export Identity Profiles - - try { - Export-IdentityProfiles - - # Below is a request that includes all optional parameters - # Export-IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-IdentityProfiles" - Write-Host $_.ErrorDetails - } - /identity-profiles/import: - post: - operationId: importIdentityProfiles - summary: Import Identity Profiles - description: This imports previously exported identity profiles. - tags: - - Identity Profiles - requestBody: - description: Previously exported Identity Profiles. - required: true - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1identity-profiles~1export/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentityProfileExportedObject.yaml - responses: - '200': - description: The result of importing Identity Profiles. - content: - application/json: - schema: - type: object - title: Import Object Response Body - description: Response model for import of a single object. - properties: - infos: - description: Informational messages returned from the target service on import. - type: array - items: - type: object - title: Config Import/Export Message - description: Message model for Config Import/Export. - properties: - key: - type: string - description: Message key. - example: UNKNOWN_REFERENCE_RESOLVER - text: - type: string - description: Message text. - example: 'Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity]' - details: - type: object - description: Message details if any, in key:value pairs. - additionalProperties: true - example: - details: message details - required: - - key - - text - - details - warnings: - description: Warning messages returned from the target service on import. - type: array - items: - $ref: '#/paths/~1identity-profiles~1import/post/responses/200/content/application~1json/schema/properties/infos/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/SpConfigMessage.yaml - errors: - description: Error messages returned from the target service on import. - type: array - items: - $ref: '#/paths/~1identity-profiles~1import/post/responses/200/content/application~1json/schema/properties/infos/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/SpConfigMessage.yaml - importedObjects: - description: References to objects that were created or updated by the import. - type: array - items: - type: object - description: Object created or updated by import. - properties: - type: - type: string - description: DTO type of object created or updated by import. - enum: - - CONNECTOR_RULE - - IDENTITY_OBJECT_CONFIG - - IDENTITY_PROFILE - - RULE - - SOURCE - - TRANSFORM - - TRIGGER_SUBSCRIPTION - example: SOURCE - id: - type: string - description: ID of object created or updated by import. - example: 2c9180835d191a86015d28455b4b232a - name: - type: string - description: Display name of object created or updated by import. - example: HR Active Directory - required: - - infos - - warnings - - errors - - importedObjects - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:identity-profile:manage - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#import-identity-profiles - source: | - - - - - - $IdentityProfileExportedObject = @"{ - "self" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - }, - "version" : 1, - "object" : { - "owner" : { - "name" : "William Wilson", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "IDENTITY" - }, - "identityExceptionReportReference" : { - "reportName" : "My annual report", - "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" - }, - "authoritativeSource" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - }, - "hasTimeBasedAttr" : true, - "created" : "2015-05-28T14:07:17Z", - "description" : "My custom flat file profile", - "identityRefreshRequired" : true, - "identityCount" : 8, - "priority" : 10, - "identityAttributeConfig" : { - "attributeTransforms" : [ { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - }, { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - } ], - "enabled" : true - }, - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "id" : "id12345" - } - }"@ - - - # Import Identity Profiles - - try { - $Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject - Import-IdentityProfiles -IdentityProfileExportedObject $Result - - # Below is a request that includes all optional parameters - # Import-IdentityProfiles -IdentityProfileExportedObject $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-IdentityProfiles" - Write-Host $_.ErrorDetails - } - /identity-profiles/identity-preview: - post: - operationId: showIdentityPreview - tags: - - Identity Profiles - summary: Generate Identity Profile Preview - description: |- - Use this API to generate a non-persisted preview of the identity object after applying `IdentityAttributeConfig` sent in request body. - This API only allows `accountAttribute`, `reference` and `rule` transform types in the `IdentityAttributeConfig` sent in the request body. - requestBody: - description: Identity Preview request body. - required: true - content: - application/json: - schema: - type: object - properties: - identityId: - type: string - format: uuid - example: 2c9180857893f12901789445619b0366 - description: The Identity id - identityAttributeConfig: - $ref: '#/components/schemas/IdentityProfile/allOf/1/properties/identityAttributeConfig' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentityAttributeConfig.yaml - responses: - '200': - description: A preview of the identity attributes after applying identity attributes config sent in request body. - content: - application/json: - schema: - type: object - properties: - identity: - type: object - description: Identity's basic details. - properties: - type: - type: string - description: Identity's DTO type. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: Identity ID. - example: 2c7180a46faadee4016fb4e018c20642 - name: - type: string - description: Identity's display name. - example: Michael Michaels - previewAttributes: - type: array - items: - type: object - properties: - name: - type: string - description: Name of the attribute that is being previewed. - example: email - value: - type: string - description: Value that was derived during the preview. - example: email@mail.com - previousValue: - type: string - description: The value of the attribute before the preview. - example: oldEmail@mail.com - errorMessages: - $ref: '#/paths/~1access-request-status/get/responses/200/content/application~1json/schema/items/properties/errorMessages/items' - description: A list of errors that may have been encountered. - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ErrorMessageDtoList.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:identity-profile:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#show-identity-preview - source: | - $IdentityPreviewRequest = @" - { - "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", - "identityAttributeConfig" : { - "attributeTransforms" : [ { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - }, { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - } ], - "enabled" : true - } - } - "@ - - # Generate Identity Profile Preview - - try { - $Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest - Show-IdentityPreview -IdentityPreviewRequest $Result - - # Below is a request that includes all optional parameters - # Show-IdentityPreview -IdentityPreviewRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-IdentityPreview" - Write-Host $_.ErrorDetails - } - /identity-profiles/{identity-profile-id}: - get: - operationId: getIdentityProfile - tags: - - Identity Profiles - summary: Get Identity Profile - description: Get a single identity profile by ID. - parameters: - - in: path - name: identity-profile-id - schema: - type: string - format: uuid - required: true - x-sailpoint-resource-operation-id: listIdentityProfiles - description: Identity profile ID. - example: 2b838de9-db9b-abcf-e646-d4f274ad4238 - responses: - '200': - description: Identity profile object. - content: - application/json: - schema: - $ref: '#/paths/~1identity-profiles/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentityProfile.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:identity-profile:read - - applicationAuth: - - idn:identity-profile:read - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#get-identity-profile - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - - # Get Identity Profile - - try { - Get-IdentityProfile -IdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Get-IdentityProfile -IdentityProfileId $IdentityProfileId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityProfile" - Write-Host $_.ErrorDetails - } - delete: - operationId: deleteIdentityProfile - tags: - - Identity Profiles - summary: Delete Identity Profile - description: |- - Delete an identity profile by ID. - On success, this endpoint will return a reference to the bulk delete task result. - parameters: - - in: path - name: identity-profile-id - schema: - type: string - format: uuid - required: true - x-sailpoint-resource-operation-id: listIdentityProfiles - description: Identity profile ID. - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '202': - description: Accepted - Returns a TaskResult object referencing the bulk delete job created. - content: - application/json: - schema: - $ref: '#/paths/~1identity-profiles~1bulk-delete/post/responses/202/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/TaskResultSimplified.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:identity-profile:delete - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#delete-identity-profile - source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. - - # Delete Identity Profile - - try { - Remove-IdentityProfile -IdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Remove-IdentityProfile -IdentityProfileId $IdentityProfileId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-IdentityProfile" - Write-Host $_.ErrorDetails - } - patch: - operationId: updateIdentityProfile - tags: - - Identity Profiles - summary: Update Identity Profile - description: |- - Update a specified identity profile with this PATCH request. - - You cannot update these fields: - * id - * created - * modified - * identityCount - * identityRefreshRequired - * Authoritative Source and Identity Attribute Configuration cannot be modified at the same time. - parameters: - - in: path - name: identity-profile-id - schema: - type: string - format: uuid - required: true - x-sailpoint-resource-operation-id: listIdentityProfiles - description: Identity profile ID. - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - description: List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml - examples: - add-attribute-transform: - summary: Add an attribute transform - value: - - op: add - path: /identityAttributeConfig/attributeTransforms/0 - value: - identityAttributeName: location - transformDefinition: - type: accountAttribute - attributes: - sourceName: Employees - attributeName: location - sourceId: 2c91808878b7d63b0178c66ffcdc4ce4 - responses: - '200': - description: Updated identity profile. - content: - application/json: - schema: - $ref: '#/paths/~1identity-profiles/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentityProfile.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:identity-profile:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#update-identity-profile - source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Identity Profile - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-IdentityProfile" - Write-Host $_.ErrorDetails - } - /identity-profiles/{identity-profile-id}/default-identity-attribute-config: - get: - operationId: getDefaultIdentityAttributeConfig - tags: - - Identity Profiles - summary: Get default Identity Attribute Config - description: This returns the default identity attribute config. - parameters: - - in: path - name: identity-profile-id - schema: - type: string - format: uuid - required: true - x-sailpoint-resource-operation-id: listIdentityProfiles - description: The Identity Profile ID. - example: 2b838de9-db9b-abcf-e646-d4f274ad4238 - responses: - '200': - description: An Identity Attribute Config object. - content: - application/json: - schema: - $ref: '#/components/schemas/IdentityProfile/allOf/1/properties/identityAttributeConfig' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentityAttributeConfig.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:identity-profile:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#get-default-identity-attribute-config - source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. - - # Get default Identity Attribute Config - - try { - Get-DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Get-DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DefaultIdentityAttributeConfig" - Write-Host $_.ErrorDetails - } - /identity-profiles/{identity-profile-id}/process-identities: - post: - operationId: syncIdentityProfile - tags: - - Identity Profiles - summary: Process identities under profile - description: |- - Process identities under the profile - This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant's timezone to keep your identities synchronized. - This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. - This operation will perform the following activities on all identities under the identity profile. - 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity's correct manager through manager correlation. 3. Updates the identity's access according to their assigned lifecycle state. 4. Updates the identity's access based on role assignment criteria. - externalDocs: - description: Learn more about manually processing identities here - url: https://documentation.sailpoint.com/saas/help/setup/identity_processing.html - parameters: - - in: path - name: identity-profile-id - schema: - type: string - format: uuid - required: true - x-sailpoint-resource-operation-id: listIdentityProfiles - description: The Identity Profile ID to be processed - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '202': - $ref: '#/paths/~1access-requests~1cancel/post/responses/202' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/202.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:identity-profile:refresh - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#sync-identity-profile - source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID to be processed - - # Process identities under profile - - try { - Sync-IdentityProfile -IdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Sync-IdentityProfile -IdentityProfileId $IdentityProfileId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-IdentityProfile" - Write-Host $_.ErrorDetails - } - /managed-clients: - get: - tags: - - Managed Clients - summary: Get Managed Clients - description: List managed clients. - operationId: getManagedClients - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq* - - **name**: *eq* - - **clientId**: *eq* - - **clusterId**: *eq* - required: false - example: name eq "client name" - responses: - '200': - description: Response with a list of managed clients, based on the specified query parameters. - content: - application/json: - schema: - type: array - items: - description: Managed Client - type: object - required: - - clientId - - clusterId - - description - - type - properties: - id: - description: ManagedClient ID - readOnly: true - nullable: true - type: string - example: 2c9180878eaf4204018eb019c3570003 - alertKey: - description: ManagedClient alert key - readOnly: true - nullable: true - type: string - example: CLIENT_STATUS_NOT_CONFIGURED - apiGatewayBaseUrl: - nullable: true - type: string - cookbook: - nullable: true - type: string - ccId: - description: Previous CC ID to be used in data migration. (This field will be deleted after CC migration!) - nullable: true - type: integer - format: int64 - example: 2248 - clientId: - description: The client ID used in API management - type: string - example: 00be54a2-bb6d-402f-9159-beb2d5319347 - clusterId: - description: Cluster ID that the ManagedClient is linked to - type: string - example: e1ff7bb24c934240bbf55e1aa39e41c5 - description: - description: ManagedClient description - type: string - default: '' - example: A short description of the ManagedClient - ipAddress: - description: The public IP address of the ManagedClient - readOnly: true - nullable: true - type: string - example: 123.456.78.90 - lastSeen: - description: When the ManagedClient was last seen by the server - readOnly: true - nullable: true - type: string - format: date-time - example: '2020-01-01T00:00:00.000000Z' - name: - description: ManagedClient name - nullable: true - type: string - default: VA-$clientId - example: aName - sinceLastSeen: - description: Milliseconds since the ManagedClient has polled the server - readOnly: true - nullable: true - type: string - example: 15000 - status: - description: Status of the ManagedClient - readOnly: true - nullable: true - type: string - enum: - - NORMAL - - UNDEFINED - - NOT_CONFIGURED - - CONFIGURING - - WARNING - - ERROR - - FAILED - - null - example: NORMAL - type: - description: Type of the ManagedClient (VA, CCG) - type: string - example: VA - clusterType: - description: Cluster Type of the ManagedClient - readOnly: true - nullable: true - type: string - enum: - - null - - idn - - iai - - spConnectCluster - - sqsCluster - - das-rc - - das-pc - - das-dc - example: idn - vaDownloadUrl: - description: ManagedClient VA download URL - readOnly: true - nullable: true - type: string - example: aUrl - vaVersion: - description: Version that the ManagedClient's VA is running - readOnly: true - nullable: true - type: string - example: va-megapod-useast1-610-1621372012 - secret: - description: Client's apiKey - nullable: true - type: string - example: ef878e15eaa8c8d3e2fa52f41125e2a0eeadadc6a14f931a33ad3e1b62d56381 - createdAt: - description: The date/time this ManagedClient was created - example: '2023-08-04T20:48:01.865Z' - nullable: true - type: string - format: date-time - updatedAt: - description: The date/time this ManagedClient was last updated - example: '2023-08-04T20:48:01.865Z' - nullable: true - type: string - format: date-time - provisionStatus: - description: The provisioning status of the ManagedClient - readOnly: true - nullable: true - type: string - enum: - - null - - PROVISIONED - - DRAFT - example: PROVISIONED - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:remote-client:read - - idn:remote-client:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-clients - source: | - $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) - $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) - $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) - $Filters = "name eq "client name"" # 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: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) - - # Get Managed Clients - - try { - Get-ManagedClients - - # Below is a request that includes all optional parameters - # Get-ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClients" - Write-Host $_.ErrorDetails - } - post: - tags: - - Managed Clients - summary: Create Managed Client - description: |- - Create a new managed client. - The API returns a result that includes the managed client ID. - operationId: createManagedClient - requestBody: - required: true - content: - application/json: - schema: - description: Managed Client Request - type: object - required: - - clusterId - properties: - clusterId: - description: Cluster ID that the ManagedClient is linked to - type: string - example: aClusterId - description: - description: description for the ManagedClient to create - type: string - nullable: true - example: A short description of the ManagedClient - name: - description: name for the ManagedClient to create - type: string - nullable: true - example: aName - type: - description: Type of the ManagedClient (VA, CCG) to create - type: string - nullable: true - example: VA - responses: - '200': - description: Created managed client. - content: - application/json: - schema: - $ref: '#/paths/~1managed-clients/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ManagedClient.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:remote-client:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#create-managed-client - source: | - $ManagedClientRequest = @" - { - "name" : "aName", - "description" : "A short description of the ManagedClient", - "clusterId" : "aClusterId", - "type" : "VA" - } - "@ - - # Create Managed Client - - try { - $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest - New-ManagedClient -ManagedClientRequest $Result - - # Below is a request that includes all optional parameters - # New-ManagedClient -ManagedClientRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedClient" - Write-Host $_.ErrorDetails - } - /managed-clients/{id}: - get: - tags: - - Managed Clients - summary: Get Managed Client - description: 'Get managed client by ID. ' - operationId: getManagedClient - parameters: - - name: id - in: path - description: Managed client ID. - required: true - x-sailpoint-resource-operation-id: getManagedClients - example: 4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7 - schema: - type: string - responses: - '200': - description: Managed client response. - content: - application/json: - schema: - $ref: '#/paths/~1managed-clients/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ManagedClient.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:remote-client:read - - idn:remote-client:manage - - idn:managed-client-status:read - - idn:managed-client-status:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-client - source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - - # Get Managed Client - - try { - Get-ManagedClient -Id $Id - - # Below is a request that includes all optional parameters - # Get-ManagedClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClient" - Write-Host $_.ErrorDetails - } - patch: - tags: - - Managed Clients - summary: Update Managed Client - description: Update an existing managed client. - operationId: updateManagedClient - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getManagedClients - description: Managed client ID. - example: 4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7 - requestBody: - required: true - description: JSONPatch payload used to update the object. - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml - responses: - '200': - description: Updated managed client. - content: - application/json: - schema: - $ref: '#/paths/~1managed-clients/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ManagedClient.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:remote-client:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#update-managed-client - source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Managed Client - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-ManagedClient -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-ManagedClient -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedClient" - Write-Host $_.ErrorDetails - } - delete: - operationId: deleteManagedClient - tags: - - Managed Clients - summary: Delete Managed Client - description: Delete an existing managed client. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getManagedClients - description: Managed client ID. - example: 4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7 - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:remote-client:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#delete-managed-client - source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - - # Delete Managed Client - - try { - Remove-ManagedClient -Id $Id - - # Below is a request that includes all optional parameters - # Remove-ManagedClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedClient" - Write-Host $_.ErrorDetails - } - /managed-clients/{id}/status: - get: - tags: - - Managed Clients - summary: Get Managed Client Status - description: Get a managed client's status, using its ID. - operationId: getManagedClientStatus - parameters: - - name: id - in: path - description: Managed client ID to get status for. - required: true - x-sailpoint-resource-operation-id: getManagedClients - schema: - type: string - example: aClientId - - name: type - in: query - description: Managed client type to get status for. - required: true - schema: - description: Managed Client type - type: string - example: CCG - nullable: true - enum: - - CCG - - VA - - INTERNAL - - IIQ_HARVESTER - - null - responses: - '200': - description: Response with the managed client status, with the given ID and type. - content: - application/json: - schema: - description: Managed Client Status - type: object - required: - - body - - status - - type - - timestamp - properties: - body: - description: ManagedClientStatus body information - type: object - example: - alertKey: '' - id: '5678' - clusterId: '1234' - ccg_etag: ccg_etag123xyz456 - ccg_pin: NONE - cookbook_etag: 20210420125956-20210511144538 - hostname: megapod-useast1-secret-hostname.sailpoint.com - internal_ip: 127.0.0.1 - lastSeen: '1620843964604' - sinceSeen: '14708' - sinceSeenMillis: '14708' - localDev: false - stacktrace: '' - state: null - status: NORMAL - uuid: null - product: idn - va_version: null - platform_version: '2' - os_version: 2345.3.1 - os_type: flatcar - hypervisor: unknown - status: - type: string - description: Status of a Managed Client - enum: - - NORMAL - - UNDEFINED - - NOT_CONFIGURED - - CONFIGURING - - WARNING - - ERROR - - FAILED - example: NORMAL - type: - description: type of the Managed Client - $ref: '#/paths/~1managed-clients~1%7Bid%7D~1status/get/parameters/1/schema' - example: CCG - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ManagedClientType.yaml - timestamp: - description: timestamp on the Client Status update - type: string - format: date-time - example: '2020-01-01T00:00:00.000000Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:managed-client-status:read - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-client-status - source: | - $Id = "aClientId" # String | Managed client ID to get status for. - $Type = "CCG" # ManagedClientType | Managed client type to get status for. - - # Get Managed Client Status - - try { - Get-ManagedClientStatus -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-ManagedClientStatus -Id $Id -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClientStatus" - Write-Host $_.ErrorDetails - } - /managed-clusters: - get: - tags: - - Managed Clusters - summary: Get Managed Clusters - description: List current organization's managed clusters, based on request context. - operationId: getManagedClusters - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml - - in: query - name: filters - schema: - type: string - description: |- - 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: - - **operational**: *eq* - required: false - example: operational eq "operation" - responses: - '200': - description: Response with a list of managed clusters. - content: - application/json: - schema: - type: array - items: - description: Managed Cluster - type: object - required: - - id - - clientType - - ccgVersion - properties: - id: - description: ManagedCluster ID - type: string - example: e1ff7bb24c934240bbf55e1aa39e41c5 - name: - description: ManagedCluster name - type: string - example: Managed Cluster Name - pod: - description: ManagedCluster pod - type: string - example: megapod-useast1 - org: - description: ManagedCluster org - type: string - example: denali - type: - type: string - description: The Type of Cluster - example: idn - enum: - - idn - - iai - configuration: - description: ManagedProcess configuration map - type: object - additionalProperties: - type: string - nullable: true - example: - clusterExternalId: e1ff7bb24c934240bbf55e1aa39e41c5 - clusterType: sqsCluster - gmtOffset: '-5' - keyPair: - description: Managed Cluster key pair for Cluster - type: object - properties: - publicKey: - nullable: true - description: ManagedCluster publicKey - type: string - example: '-----BEGIN PUBLIC KEY-----******-----END PUBLIC KEY-----' - publicKeyThumbprint: - nullable: true - description: ManagedCluster publicKeyThumbprint - type: string - example: 6CMlaJIV44-xJxcB3CJBjDUUn54 - publicKeyCertificate: - nullable: true - description: ManagedCluster publicKeyCertificate - type: string - example: '-----BEGIN CERTIFICATE-----****-----END CERTIFICATE-----' - attributes: - description: Managed Cluster Attributes for Cluster Configuration. Supported Cluster Types [sqsCluster, spConnectCluster] - type: object - properties: - queue: - description: Managed Cluster key pair for Cluster - type: object - properties: - name: - description: ManagedCluster queue name - type: string - example: megapod-useast1-denali-lwt-cluster-1533 - region: - description: ManagedCluster queue aws region - type: string - example: us-east-1 - keystore: - nullable: true - description: ManagedCluster keystore for spConnectCluster type - type: string - example: /u3+7QAAAAIAAAABAAAAAQAvL3Byb3h5LWNsdXN0ZXIvMmM5MTgwODc3Yjg3MW - description: - description: ManagedCluster description - type: string - default: q - example: A short description of the managed cluster. - redis: - description: Managed Cluster Redis Configuration - type: object - properties: - redisHost: - description: ManagedCluster redisHost - type: string - example: megapod-useast1-shared-redis.cloud.sailpoint.com - redisPort: - description: ManagedCluster redisPort - type: integer - format: int32 - example: 6379 - clientType: - description: type of client for the ManagedCluster - $ref: '#/paths/~1managed-clients~1%7Bid%7D~1status/get/parameters/1/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ManagedClientType.yaml - ccgVersion: - description: CCG version used by the ManagedCluster - type: string - example: v01 - pinnedConfig: - description: boolean flag indiacting whether or not the cluster configuration is pinned - type: boolean - default: false - example: false - logConfiguration: - description: client log configuration for the cluster - example: '{ "rootLevel": "WARN", "logLevels": { "foobar": "WARN" } }' - $ref: '#/paths/~1managed-clusters~1%7Bid%7D~1log-config/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ClientLogConfiguration.yaml - operational: - description: Whether or not the cluster is operational or not - type: boolean - default: false - example: false - status: - description: Cluster status - type: string - example: NORMAL - publicKeyCertificate: - nullable: true - description: Public key certificate - type: string - example: '-----BEGIN CERTIFICATE-----TCCAb2gAwIBAgIBADANBgkqhkiG9w0BAQsFADAuMQ0wCwYDVQQD-----END CERTIFICATE-----' - publicKeyThumbprint: - nullable: true - description: Public key thumbprint - type: string - example: obc6pLiulGbtZ - publicKey: - nullable: true - description: Public key - type: string - example: '-----BEGIN PUBLIC KEY-----jANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA3WgnsxP52MDgBTfHR+5n4-----END PUBLIC KEY-----' - alertKey: - description: Key describing any immediate cluster alerts - type: string - example: LIMITED_RESOURCES - clientIds: - type: array - description: List of clients in a cluster - items: - type: string - example: - - '1244' - - '1245' - serviceCount: - description: Number of services bound to a cluster - type: integer - format: int32 - default: 0 - example: 6 - ccId: - description: CC ID only used in calling CC, will be removed without notice when Migration to CEGS is finished - type: string - default: '0' - example: '1533' - createdAt: - description: The date/time this cluster was created - example: '2023-08-04T20:48:01.865Z' - nullable: true - type: string - format: date-time - updatedAt: - description: The date/time this cluster was last updated - example: '2023-08-04T20:48:01.865Z' - nullable: true - type: string - format: date-time - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:remote-client:read - - idn:remote-client:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-managed-clusters - source: | - $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) - $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) - $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) - $Filters = "operational eq "operation"" # 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: **operational**: *eq* (optional) - - # Get Managed Clusters - - try { - Get-ManagedClusters - - # Below is a request that includes all optional parameters - # Get-ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClusters" - Write-Host $_.ErrorDetails - } - post: - tags: - - Managed Clusters - summary: Create Create Managed Cluster - description: |- - Create a new Managed Cluster. - The API returns a result that includes the managed cluster ID. - operationId: createManagedCluster - requestBody: - required: true - content: - application/json: - schema: - description: Request to create Managed Cluster - type: object - required: - - name - properties: - name: - description: ManagedCluster name - type: string - nullable: false - example: Managed Cluster Name - type: - $ref: '#/paths/~1managed-clusters/get/responses/200/content/application~1json/schema/items/properties/type' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ManagedClusterTypes.yaml - configuration: - description: ManagedProcess configuration map - type: object - additionalProperties: - type: string - example: - clusterExternalId: externalId - ccgVersion: 77.0.0 - description: - description: ManagedCluster description - type: string - nullable: true - example: A short description of the managed cluster. - responses: - '200': - description: Created managed cluster. - content: - application/json: - schema: - $ref: '#/paths/~1managed-clusters/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ManagedCluster.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:remote-client:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#create-managed-cluster - source: | - $ManagedClusterRequest = @" - { - "configuration" : { - "clusterExternalId" : "externalId", - "ccgVersion" : "77.0.0" - }, - "name" : "Managed Cluster Name", - "description" : "A short description of the managed cluster.", - "type" : "idn" - } - "@ - - # Create Create Managed Cluster - - try { - $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest - New-ManagedCluster -ManagedClusterRequest $Result - - # Below is a request that includes all optional parameters - # New-ManagedCluster -ManagedClusterRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedCluster" - Write-Host $_.ErrorDetails - } - /managed-clusters/{id}: - get: - tags: - - Managed Clusters - summary: Get Managed Cluster - description: Get a managed cluster by ID. - operationId: getManagedCluster - parameters: - - name: id - in: path - description: Managed cluster ID. - required: true - x-sailpoint-resource-operation-id: getManagedClusters - example: 2c9180897de347a2017de8859e8c5039 - style: simple - explode: false - schema: - type: string - responses: - '200': - description: Response with managed cluster for the given ID. - content: - application/json: - schema: - $ref: '#/paths/~1managed-clusters/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ManagedCluster.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:remote-client:read - - idn:remote-client:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - - # Get Managed Cluster - - try { - Get-ManagedCluster -Id $Id - - # Below is a request that includes all optional parameters - # Get-ManagedCluster -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedCluster" - Write-Host $_.ErrorDetails - } - patch: - tags: - - Managed Clusters - summary: Update Managed Cluster - description: Update an existing managed cluster. - operationId: updateManagedCluster - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getManagedClusters - description: Managed cluster ID. - example: 2c9180897de347a2017de8859e8c5039 - requestBody: - required: true - description: JSONPatch payload used to update the object. - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml - responses: - '200': - description: Updated managed cluster. - content: - application/json: - schema: - $ref: '#/paths/~1managed-clusters/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ManagedCluster.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:remote-client:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#update-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Managed Cluster - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-ManagedCluster -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-ManagedCluster -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedCluster" - Write-Host $_.ErrorDetails - } - delete: - operationId: deleteManagedCluster - tags: - - Managed Clusters - summary: Delete Managed Cluster - description: Delete an existing managed cluster. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getManagedClusters - description: Managed cluster ID. - example: 2c9180897de347a2017de8859e8c5039 - - in: query - name: removeClients - schema: - type: boolean - default: false - required: false - description: Flag to determine the need to delete a cluster with clients. - example: false - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:remote-client:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#delete-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) - - # Delete Managed Cluster - - try { - Remove-ManagedCluster -Id $Id - - # Below is a request that includes all optional parameters - # Remove-ManagedCluster -Id $Id -RemoveClients $RemoveClients - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedCluster" - Write-Host $_.ErrorDetails - } - /managed-clusters/{id}/log-config: - get: - tags: - - Managed Clusters - summary: Get Managed Cluster Log Configuration - description: Get a managed cluster's log configuration. - operationId: getClientLogConfiguration - parameters: - - name: id - in: path - description: ID of managed cluster to get log configuration for. - required: true - x-sailpoint-resource-operation-id: getManagedClusters - schema: - type: string - format: uuid - example: 2b838de9-db9b-abcf-e646-d4f274ad4238 - responses: - '200': - description: Log configuration of managed cluster for given cluster ID. - content: - application/json: - schema: - description: Client Runtime Logging Configuration - nullable: true - type: object - required: - - rootLevel - properties: - clientId: - description: Log configuration's client ID - type: string - example: 3a38a51992e8445ab51a549c0a70ee66 - durationMinutes: - description: Duration in minutes for log configuration to remain in effect before resetting to defaults. - type: integer - format: int32 - example: 120 - default: 240 - minimum: 5 - maximum: 1440 - expiration: - description: Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. - example: '2024-11-06T01:31:08.013164Z' - type: string - format: date-time - rootLevel: - description: Standard Log4j log level - type: string - example: INFO - enum: - - 'OFF' - - FATAL - - ERROR - - WARN - - INFO - - DEBUG - - TRACE - logLevels: - description: Mapping of identifiers to Standard Log Level values - type: object - example: INFO - additionalProperties: - default: INFO - example: TRACE - $ref: '#/paths/~1managed-clusters~1%7Bid%7D~1log-config/get/responses/200/content/application~1json/schema/properties/rootLevel' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/StandardLevel.yaml - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:remote-client:read - - idn:remote-client:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-client-log-configuration - source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. - - # Get Managed Cluster Log Configuration - - try { - Get-ClientLogConfiguration -Id $Id - - # Below is a request that includes all optional parameters - # Get-ClientLogConfiguration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ClientLogConfiguration" - Write-Host $_.ErrorDetails - } - put: - tags: - - Managed Clusters - summary: Update Managed Cluster Log Configuration - description: Update a managed cluster's log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240. - operationId: putClientLogConfiguration - parameters: - - name: id - in: path - description: ID of the managed cluster to update the log configuration for. - required: true - x-sailpoint-resource-operation-id: getManagedClusters - schema: - type: string - format: uuid - example: 2b838de9-db9b-abcf-e646-d4f274ad4238 - requestBody: - description: Client log configuration for the given managed cluster. - content: - application/json: - schema: - oneOf: - - description: Client Runtime Logging Configuration - title: Set Duration Minutes - nullable: true - type: object - required: - - rootLevel - properties: - clientId: - description: Log configuration's client ID - type: string - example: 3a38a51992e8445ab51a549c0a70ee66 - durationMinutes: - description: Duration in minutes for log configuration to remain in effect before resetting to defaults. - type: integer - format: int32 - example: 120 - default: 240 - minimum: 5 - maximum: 1440 - rootLevel: - $ref: '#/paths/~1managed-clusters~1%7Bid%7D~1log-config/get/responses/200/content/application~1json/schema/properties/rootLevel' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/StandardLevel.yaml - logLevels: - $ref: '#/paths/~1managed-clusters~1%7Bid%7D~1log-config/get/responses/200/content/application~1json/schema/properties/logLevels' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/LogLevelSpec.yaml - - description: Client Runtime Logging Configuration - title: Set Expiration Date - nullable: true - type: object - required: - - rootLevel - properties: - clientId: - description: Log configuration's client ID - type: string - example: 3a38a51992e8445ab51a549c0a70ee66 - expiration: - description: Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. - example: '2024-11-06T01:31:08.013164Z' - type: string - format: date-time - rootLevel: - $ref: '#/paths/~1managed-clusters~1%7Bid%7D~1log-config/get/responses/200/content/application~1json/schema/properties/rootLevel' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/StandardLevel.yaml - logLevels: - $ref: '#/paths/~1managed-clusters~1%7Bid%7D~1log-config/get/responses/200/content/application~1json/schema/properties/logLevels' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/LogLevelSpec.yaml - examples: - Duration Minutes: - summary: Duration Minutes - value: - clientId: 3a38a51992e8445ab51a549c0a70ee66 - durationMinutes: 120 - rootLevel: INFO - logLevels: - sailpoint.connector.ADLDAPConnector: TRACE - sailpoint.connector.JDBCConnector: DEBUG - Expiration: - summary: Expiration - value: - clientId: 3a38a51992e8445ab51a549c0a70ee66 - expiration: '2024-11-06T01:31:08.013164Z' - rootLevel: INFO - logLevels: - sailpoint.connector.ADLDAPConnector: TRACE - sailpoint.connector.JDBCConnector: DEBUG - required: true - responses: - '200': - description: Response with updated client log configuration for the given managed cluster. - content: - application/json: - schema: - $ref: '#/paths/~1managed-clusters~1%7Bid%7D~1log-config/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ClientLogConfiguration.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:remote-client:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#put-client-log-configuration - source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. - $PutClientLogConfigurationRequest = @" - - "@ - - # Update Managed Cluster Log Configuration - - try { - $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest - Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result - - # Below is a request that includes all optional parameters - # Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ClientLogConfiguration" - Write-Host $_.ErrorDetails - } - /mfa/okta-verify/config: - get: - operationId: getMFAOktaConfig - tags: - - MFA Configuration - summary: Configuration of Okta MFA method - description: This API returns the configuration of an Okta MFA method. - security: - - userAuth: - - idn:mfa-configuration:read - - idn:mfa-configuration:manage - x-sailpoint-userLevels: - - ORG_ADMIN - responses: - '200': - description: The configuration of an Okta MFA method. - content: - application/json: - schema: - type: object - properties: - mfaMethod: - type: string - nullable: true - description: Mfa method name - example: okta-verify - enabled: - type: boolean - description: If MFA method is enabled. - default: false - example: true - host: - type: string - nullable: true - description: The server host name or IP address of the MFA provider. - example: example.com - accessKey: - type: string - nullable: true - description: The secret key for authenticating requests to the MFA provider. - example: qw123Y3QlA5UqocYpdU3rEkzrK2D497y - identityAttribute: - type: string - nullable: true - description: Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. - example: email - example: - mfaMethod: okta-verify - enabled: true - host: www.example.com - accessKey: d******Y - identityAttribute: email - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#get-mfa-okta-config - source: | - - # Configuration of Okta MFA method - - try { - Get-MFAOktaConfig - - # Below is a request that includes all optional parameters - # Get-MFAOktaConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MFAOktaConfig" - Write-Host $_.ErrorDetails - } - put: - operationId: setMFAOktaConfig - tags: - - MFA Configuration - summary: Set Okta MFA configuration - description: This API sets the configuration of an Okta MFA method. - security: - - userAuth: - - idn:mfa-configuration:manage - x-sailpoint-userLevels: - - ORG_ADMIN - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1mfa~1okta-verify~1config/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/MfaOktaConfig.yaml - example: - mfaMethod: okta-verify - enabled: true - host: www.example.com - accessKey: dk778Y3QlA5UqocYpdU3rEkzrK2D497y - identityAttribute: email - responses: - '200': - description: MFA configuration of an Okta MFA method. - content: - application/json: - schema: - $ref: '#/paths/~1mfa~1okta-verify~1config/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/MfaOktaConfig.yaml - example: - mfaMethod: okta-verify - enabled: true - host: www.example.com - accessKey: d******Y - identityAttribute: email - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#set-mfa-okta-config - source: | - $MfaOktaConfig = @" - { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "mfaMethod" : "okta-verify", - "enabled" : true, - "identityAttribute" : "email" - } - "@ - - # Set Okta MFA configuration - - try { - $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig - Set-MFAOktaConfig -MfaOktaConfig $Result - - # Below is a request that includes all optional parameters - # Set-MFAOktaConfig -MfaOktaConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFAOktaConfig" - Write-Host $_.ErrorDetails - } - /mfa/duo-web/config: - get: - operationId: getMFADuoConfig - tags: - - MFA Configuration - summary: Configuration of Duo MFA method - description: This API returns the configuration of an Duo MFA method. - security: - - userAuth: - - idn:mfa-configuration:read - - idn:mfa-configuration:manage - x-sailpoint-userLevels: - - ORG_ADMIN - responses: - '200': - description: The configuration of an Duo MFA method. - content: - application/json: - schema: - type: object - properties: - mfaMethod: - type: string - nullable: true - description: Mfa method name - example: duo-web - enabled: - type: boolean - description: If MFA method is enabled. - default: false - example: true - host: - type: string - nullable: true - description: The server host name or IP address of the MFA provider. - example: example.com - accessKey: - type: string - nullable: true - description: The secret key for authenticating requests to the MFA provider. - example: qw123Y3QlA5UqocYpdU3rEkzrK2D497y - identityAttribute: - type: string - nullable: true - description: Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. - example: email - configProperties: - description: A map with additional config properties for the given MFA method - duo-web. - type: object - nullable: true - additionalProperties: true - example: - skey: qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x - ikey: Q123WE45R6TY7890ZXCV - example: - mfaMethod: duo-web - enabled: true - host: www.example.com - accessKey: d******Y - identityAttribute: email - configProperties: - skey: 6******B - ikey: Q123WE45R6TY7890ZXCV - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#get-mfa-duo-config - source: | - - # Configuration of Duo MFA method - - try { - Get-MFADuoConfig - - # Below is a request that includes all optional parameters - # Get-MFADuoConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MFADuoConfig" - Write-Host $_.ErrorDetails - } - put: - operationId: setMFADuoConfig - tags: - - MFA Configuration - summary: Set Duo MFA configuration - description: This API sets the configuration of an Duo MFA method. - security: - - userAuth: - - idn:mfa-configuration:manage - x-sailpoint-userLevels: - - ORG_ADMIN - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1mfa~1duo-web~1config/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/MfaDuoConfig.yaml - example: - mfaMethod: duo-web - enabled: true - host: www.example.com - accessKey: qw123Y3QlA5UqocYpdU3rEkzrK2D497y - identityAttribute: email - configProperties: - skey: 12q3WERlcUHWJmiMqyCXI3uOF7EaDJTbdeOp6E2B - ikey: Q123WE45R6TY7890ZXCV - responses: - '200': - description: MFA configuration of an Duo MFA method. - content: - application/json: - schema: - $ref: '#/paths/~1mfa~1duo-web~1config/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/MfaDuoConfig.yaml - example: - mfaMethod: duo-web - enabled: true - host: www.example.com - accessKey: q******y - identityAttribute: email - configProperties: - skey: 1******B - ikey: Q123WE45R6TY7890ZXCV - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#set-mfa-duo-config - source: | - $MfaDuoConfig = @" - { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "configProperties" : { - "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", - "ikey" : "Q123WE45R6TY7890ZXCV" - }, - "mfaMethod" : "duo-web", - "enabled" : true, - "identityAttribute" : "email" - } - "@ - - # Set Duo MFA configuration - - try { - $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig - Set-MFADuoConfig -MfaDuoConfig $Result - - # Below is a request that includes all optional parameters - # Set-MFADuoConfig -MfaDuoConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFADuoConfig" - Write-Host $_.ErrorDetails - } - /mfa/kba/config: - get: - operationId: getMFAKbaConfig - tags: - - MFA Configuration - summary: Configuration of KBA MFA method - description: This API returns the KBA configuration for MFA. - parameters: - - in: query - name: allLanguages - required: false - schema: - type: boolean - description: |- - Indicator whether the question text should be returned in all configured languages - * If true, the question text is returned in all languages that it is configured in. - * If false, the question text is returned in the user locale if available, else for the default locale. - * If not passed, it behaves the same way as passing this parameter as false - example: allLanguages=true - security: - - userAuth: - - idn:mfa-kba:read - x-sailpoint-userLevels: - - ORG_ADMIN - - USER - responses: - '200': - description: The configuration for KBA MFA method. - content: - application/json: - schema: - type: array - items: - description: KBA Configuration - type: object - properties: - id: - type: string - nullable: false - description: KBA Question Id - example: 143cfd3b-c23f-426b-ae5f-d3db06fa5919 - text: - type: string - nullable: false - description: KBA Question description - example: '[{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}]' - hasAnswer: - type: boolean - nullable: false - description: Denotes whether the KBA question has an answer configured for any user in the tenant - example: true - numAnswers: - type: integer - format: int32 - nullable: false - description: Denotes the number of KBA configurations for this question - example: 5 - required: - - id - - text - - hasAnswer - - numAnswers - example: - - id: 143cfd3b-c23f-426b-ae5f-d3db06fa5919 - text: MFA new question -1 ? - hasAnswer: false - numAnswers: 0 - - id: '173421' - text: What is your alphanumeric PIN? - hasAnswer: false - numAnswers: 3 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#get-mfa-kba-config - source: | - $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) - - # Configuration of KBA MFA method - - try { - Get-MFAKbaConfig - - # Below is a request that includes all optional parameters - # Get-MFAKbaConfig -AllLanguages $AllLanguages - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MFAKbaConfig" - Write-Host $_.ErrorDetails - } - /mfa/kba/config/answers: - post: - operationId: setMFAKBAConfig - tags: - - MFA Configuration - summary: Set MFA KBA configuration - description: 'This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. ' - requestBody: - required: true - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - nullable: false - description: Question Id - example: c54fee53-2d63-4fc5-9259-3e93b9994135 - answer: - type: string - nullable: false - description: An answer for the KBA question - example: Your answer - required: - - id - - answer - example: - - id: '173423' - answer: 822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34 - - id: c54fee53-2d63-4fc5-9259-3e93b9994135 - answer: 9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08 - security: - - userAuth: - - idn:mfa-kba:authenticate - x-sailpoint-userLevels: - - USER - responses: - '200': - description: The new KBA configuration for the user. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - nullable: false - description: Question Id - example: c54fee53-2d63-4fc5-9259-3e93b9994135 - question: - type: string - nullable: false - description: Question description - example: '[{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}]' - hasAnswer: - type: boolean - nullable: false - description: Denotes whether the KBA question has an answer configured for the current user - example: true - required: - - id - - question - - hasAnswer - example: - - id: 143cfd3b-c23f-426b-ae5f-d3db06fa5919 - question: '[{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}]' - hasAnswer: false - - id: '173421' - question: '[{"text":"What is your alphanumeric PIN?","locale":""}]' - hasAnswer: true - - id: c54fee53-2d63-4fc5-9259-3e93b9994135 - question: '[{"text":"Nouvelle question MFA - 2 ?","locale":"fr"},{"text":"MFA new question - 2 ?","locale":""}]' - hasAnswer: true - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#set-mfakba-config - source: | - $KbaAnswerRequestItem = @"{ - "answer" : "Your answer", - "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" - }"@ - - - # Set MFA KBA configuration - - try { - $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem - Set-MFAKBAConfig -KbaAnswerRequestItem $Result - - # Below is a request that includes all optional parameters - # Set-MFAKBAConfig -KbaAnswerRequestItem $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFAKBAConfig" - Write-Host $_.ErrorDetails - } - /mfa/{method}/test: - get: - operationId: testMFAConfig - tags: - - MFA Configuration - summary: MFA method's test configuration - description: This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. - security: - - userAuth: - - idn:mfa-configuration:read - - idn:mfa-configuration:manage - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: method - schema: - type: string - example: okta-verify - nullable: false - enum: - - okta-verify - - duo-web - required: true - description: The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - responses: - '200': - description: The result of configuration test for the MFA provider. - content: - application/json: - schema: - description: Response model for configuration test of a given MFA method - type: object - properties: - state: - type: string - enum: - - SUCCESS - - FAILED - description: The configuration test result. - example: SUCCESS - readOnly: true - error: - type: string - example: MFA Method is disabled. - description: The error message to indicate the failure of configuration test. - readOnly: true - example: - state: SUCCESS - error: null - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#test-mfa-config - source: | - $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - - # MFA method's test configuration - - try { - Test-MFAConfig -Method $Method - - # Below is a request that includes all optional parameters - # Test-MFAConfig -Method $Method - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-MFAConfig" - Write-Host $_.ErrorDetails - } - /mfa/{method}/delete: - delete: - operationId: deleteMFAConfig - tags: - - MFA Configuration - summary: Delete MFA method configuration - description: This API removes the configuration for the specified MFA method. - security: - - userAuth: - - idn:mfa-configuration:manage - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: method - schema: - type: string - example: okta-verify - nullable: false - enum: - - okta-verify - - duo-web - required: true - description: The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - responses: - '200': - description: MFA configuration of an MFA method. - content: - application/json: - schema: - $ref: '#/paths/~1mfa~1okta-verify~1config/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/MfaOktaConfig.yaml - example: - mfaMethod: okta-verify - enabled: true - host: www.example.com - accessKey: d******Y - identityAttribute: email - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#delete-mfa-config - source: | - $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - - # Delete MFA method configuration - - try { - Remove-MFAConfig -Method $Method - - # Below is a request that includes all optional parameters - # Remove-MFAConfig -Method $Method - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-MFAConfig" - Write-Host $_.ErrorDetails - } - /mfa/okta-verify/verify: - post: - operationId: sendOktaVerifyRequest - tags: - - MFA Controller - summary: Verifying authentication via Okta method - description: This API Authenticates the user via Okta-Verify MFA method. Request requires a header called 'slpt-forwarding', and it must contain a remote IP Address of caller. - security: - - userAuth: - - idn:mfa:verify - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - userId: - type: string - nullable: false - description: User identifier for Verification request. The value of the user's attribute. - example: example@mail.com - required: - - userId - example: - userId: example@mail.com - responses: - '200': - description: The status of verification request. - content: - application/json: - schema: - type: object - properties: - requestId: - type: string - nullable: true - description: The verificationPollRequest request ID - example: 089899f13a8f4da7824996191587bab9 - status: - type: string - enum: - - PENDING - - SUCCESS - - FAILED - - LOCKOUT - - NOT_ENOUGH_DATA - description: MFA Authentication status - example: SUCCESS - error: - type: string - nullable: true - description: Error messages from MFA verification request - example: Unable to connect DUO Service during verification - example: - requestId: 089899f13a8f4da7824996191587bab9 - status: SUCCESS - error: '' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#send-okta-verify-request - source: | - $OktaVerificationRequest = @" - { - "userId" : "example@mail.com" - } - "@ - - # Verifying authentication via Okta method - - try { - $Result = ConvertFrom-JsonToOktaVerificationRequest -Json $OktaVerificationRequest - Send-OktaVerifyRequest -OktaVerificationRequest $Result - - # Below is a request that includes all optional parameters - # Send-OktaVerifyRequest -OktaVerificationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-OktaVerifyRequest" - Write-Host $_.ErrorDetails - } - /mfa/duo-web/verify: - post: - operationId: sendDuoVerifyRequest - tags: - - MFA Controller - summary: Verifying authentication via Duo method - description: This API Authenticates the user via Duo-Web MFA method. - security: - - userAuth: - - idn:mfa:verify - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - userId: - type: string - nullable: false - description: User id for Verification request. - example: 2c9180947f0ef465017f215cbcfd004b - signedResponse: - type: string - nullable: false - description: User id for Verification request. - example: AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2 - required: - - userId - - signedResponse - example: - userId: 2c9180947f0ef465017f215cbcfd004b - signedResponse: AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2 - responses: - '200': - description: The status of verification request. - content: - application/json: - schema: - $ref: '#/paths/~1mfa~1okta-verify~1verify/post/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/VerificationResponse.yaml - example: - requestId: 089899f13a8f4da7824996191587bab9 - status: SUCCESS - error: '' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#send-duo-verify-request - source: | - $DuoVerificationRequest = @" - { - "signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2", - "userId" : "2c9180947f0ef465017f215cbcfd004b" - } - "@ - - # Verifying authentication via Duo method - - try { - $Result = ConvertFrom-JsonToDuoVerificationRequest -Json $DuoVerificationRequest - Send-DuoVerifyRequest -DuoVerificationRequest $Result - - # Below is a request that includes all optional parameters - # Send-DuoVerifyRequest -DuoVerificationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-DuoVerifyRequest" - Write-Host $_.ErrorDetails - } - /mfa/{method}/poll: - post: - operationId: pingVerificationStatus - tags: - - MFA Controller - summary: Polling MFA method by VerificationPollRequest - description: This API poll the VerificationPollRequest for the specified MFA method. - security: - - userAuth: - - idn:mfa:poll - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: method - schema: - type: string - example: okta-verify - nullable: false - enum: - - okta-verify - - duo-web - - kba - - token - - rsa - required: true - description: The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - requestId: - type: string - nullable: false - description: Verification request Id - example: 089899f13a8f4da7824996191587bab9 - required: - - requestId - example: - requestId: 089899f13a8f4da7824996191587bab9 - responses: - '200': - description: MFA VerificationPollRequest status an MFA method. - content: - application/json: - schema: - $ref: '#/paths/~1mfa~1okta-verify~1verify/post/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/VerificationResponse.yaml - example: - requestId: 089899f13a8f4da7824996191587bab9 - status: PENDING - error: '' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#ping-verification-status - source: | - $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' - $VerificationPollRequest = @" - { - "requestId" : "089899f13a8f4da7824996191587bab9" - } - "@ - - # Polling MFA method by VerificationPollRequest - - try { - $Result = ConvertFrom-JsonToVerificationPollRequest -Json $VerificationPollRequest - Ping-VerificationStatus -Method $Method -VerificationPollRequest $Result - - # Below is a request that includes all optional parameters - # Ping-VerificationStatus -Method $Method -VerificationPollRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-VerificationStatus" - Write-Host $_.ErrorDetails - } - /mfa/kba/authenticate: - post: - operationId: sendKbaAnswers - tags: - - MFA Controller - summary: Authenticate KBA provided MFA method - description: This API Authenticate user in KBA MFA method. - security: - - userAuth: - - idn:mfa-kba:authenticate - requestBody: - required: true - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1mfa~1kba~1config~1answers/post/requestBody/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/KbaAnswerRequestItem.yaml - example: - - id: '173423' - answer: 822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34 - - id: c54fee53-2d63-4fc5-9259-3e93b9994135 - answer: 9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08 - responses: - '200': - description: KBA authenticated status. - content: - application/json: - schema: - type: object - properties: - kbaAuthResponseItems: - type: array - example: - - questionId: 089899f13a8f4da7824996191587bab9 - isVerified: false - items: - type: object - properties: - questionId: - type: string - nullable: true - description: The KBA question id - example: 089899f13a8f4da7824996191587bab9 - isVerified: - type: boolean - nullable: true - default: null - description: Return true if verified - example: true - status: - type: string - enum: - - PENDING - - SUCCESS - - FAILED - - LOCKOUT - - NOT_ENOUGH_DATA - description: MFA Authentication status - example: PENDING - example: - kbaAuthResponseItem: - - questionId: 089899f13a8f4da7824996191587bab9 - IsVerified: false - - questionId: 089899f13a8f4da7824996191587bda8 - IsVerified: true - status: PENDING - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#send-kba-answers - source: | - $KbaAnswerRequestItem = @"{ - "answer" : "Your answer", - "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" - }"@ - - - # Authenticate KBA provided MFA method - - try { - $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem - Send-KbaAnswers -KbaAnswerRequestItem $Result - - # Below is a request that includes all optional parameters - # Send-KbaAnswers -KbaAnswerRequestItem $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-KbaAnswers" - Write-Host $_.ErrorDetails - } - /mfa/token/authenticate: - post: - operationId: sendTokenAuthRequest - tags: - - MFA Controller - summary: Authenticate Token provided MFA method - description: This API Authenticate user in Token MFA method. - security: - - userAuth: - - idn:mfa:verify - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - token: - nullable: false - type: string - description: Token value - example: '12345' - userAlias: - nullable: false - type: string - description: User alias from table spt_identity field named 'name' - example: will.albin - deliveryType: - nullable: false - type: string - enum: - - SMS_PERSONAL - - VOICE_PERSONAL - - SMS_WORK - - VOICE_WORK - - EMAIL_WORK - - EMAIL_PERSONAL - description: Token delivery type - example: EMAIL_WORK - required: - - token - - userAlias - - deliveryType - example: - token: '12345' - userAlias: will.albin - deliveryType: EMAIL_WORK - responses: - '200': - description: Token authenticated status. - content: - application/json: - schema: - type: object - properties: - status: - type: string - enum: - - PENDING - - SUCCESS - - FAILED - - LOCKOUT - - NOT_ENOUGH_DATA - description: MFA Authentication status - example: PENDING - example: - status: PENDING - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#send-token-auth-request - source: | - $TokenAuthRequest = @" - { - "userAlias" : "will.albin", - "deliveryType" : "EMAIL_WORK", - "token" : "12345" - } - "@ - - # Authenticate Token provided MFA method - - try { - $Result = ConvertFrom-JsonToTokenAuthRequest -Json $TokenAuthRequest - Send-TokenAuthRequest -TokenAuthRequest $Result - - # Below is a request that includes all optional parameters - # Send-TokenAuthRequest -TokenAuthRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-TokenAuthRequest" - Write-Host $_.ErrorDetails - } - /mfa/token/send: - post: - operationId: createSendToken - tags: - - MFA Controller - summary: Create and send user token - description: This API send token request. - security: - - userAuth: - - idn:mfa:send - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - userAlias: - nullable: false - type: string - description: User alias from table spt_identity field named 'name' - example: will.albin - deliveryType: - nullable: false - type: string - enum: - - SMS_PERSONAL - - VOICE_PERSONAL - - SMS_WORK - - VOICE_WORK - - EMAIL_WORK - - EMAIL_PERSONAL - description: Token delivery type - example: EMAIL_WORK - required: - - userAlias - - deliveryType - example: - userAlias: will.albin - deliveryType: EMAIL_WORK - responses: - '200': - description: Token send status. - content: - application/json: - schema: - type: object - properties: - requestId: - type: string - nullable: true - description: The token request ID - example: 089899f13a8f4da7824996191587bab9 - status: - type: string - enum: - - SUCCESS - - FAILED - description: Status of sending token - example: SUCCESS - errorMessage: - type: string - nullable: true - description: Error messages from token send request - example: Unable to sent text message - example: - requestId: 089899f13a8f4da7824996191587bab9 - status: SUCCESS - errorMessage: '' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#create-send-token - source: | - $SendTokenRequest = @" - { - "userAlias" : "will.albin", - "deliveryType" : "EMAIL_WORK" - } - "@ - - # Create and send user token - - try { - $Result = ConvertFrom-JsonToSendTokenRequest -Json $SendTokenRequest - New-SendToken -SendTokenRequest $Result - - # Below is a request that includes all optional parameters - # New-SendToken -SendTokenRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SendToken" - Write-Host $_.ErrorDetails - } - /non-employee-records: - post: - operationId: createNonEmployeeRecord - tags: - - Non-Employee Lifecycle Management - summary: Create Non-Employee Record - description: |- - This request will create a non-employee record. - Requires role context of `idn:nesr:create` - requestBody: - description: Non-Employee record creation request body. - required: true - content: - application/json: - schema: - type: object - properties: - accountName: - type: string - description: Requested identity account name. - example: william.smith - firstName: - type: string - description: Non-Employee's first name. - example: William - lastName: - type: string - description: Non-Employee's last name. - example: Smith - email: - type: string - description: Non-Employee's email. - example: william.smith@example.com - phone: - type: string - description: Non-Employee's phone. - example: '5125555555' - manager: - type: string - description: The account ID of a valid identity to serve as this non-employee's manager. - example: jane.doe - sourceId: - type: string - description: Non-Employee's source id. - example: 2c91808568c529c60168cca6f90c1313 - data: - type: object - additionalProperties: - type: string - description: Additional attributes for a non-employee. Up to 10 custom attributes can be added. - example: - description: Auditing - startDate: - type: string - format: date-time - description: Non-Employee employment start date. - example: '2020-03-24T00:00:00-05:00' - endDate: - type: string - format: date-time - description: Non-Employee employment end date. - example: '2021-03-25T00:00:00-05:00' - required: - - accountName - - firstName - - lastName - - email - - phone - - manager - - sourceId - - startDate - - endDate - responses: - '200': - description: Created non-employee record. - content: - application/json: - schema: - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee record id. - example: ef38f94347e94562b5bb8424a56397d8 - accountName: - type: string - description: Requested identity account name. - example: Abby.Smith - firstName: - type: string - description: Non-Employee's first name. - example: William - lastName: - type: string - description: Non-Employee's last name. - example: Smith - email: - type: string - description: Non-Employee's email. - example: william.smith@example.com - phone: - type: string - description: Non-Employee's phone. - example: '5125555555' - manager: - type: string - description: The account ID of a valid identity to serve as this non-employee's manager. - example: jane.doe - sourceId: - type: string - description: Non-Employee's source id. - example: 2c91808568c529c60168cca6f90c1313 - data: - type: object - additionalProperties: - type: string - description: Additional attributes for a non-employee. Up to 10 custom attributes can be added. - example: - description: Auditing - startDate: - type: string - format: date-time - description: Non-Employee employment start date. - example: '2019-08-23T18:52:59.162Z' - endDate: - type: string - format: date-time - description: Non-Employee employment end date. - example: '2020-08-23T18:52:59.162Z' - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#create-non-employee-record - source: | - $NonEmployeeRequestBody = @" - { - "sourceId" : "2c91808568c529c60168cca6f90c1313", - "firstName" : "William", - "lastName" : "Smith", - "manager" : "jane.doe", - "data" : { - "description" : "Auditing" - }, - "accountName" : "william.smith", - "phone" : "5125555555", - "endDate" : "2021-03-25T00:00:00-05:00", - "email" : "william.smith@example.com", - "startDate" : "2020-03-24T00:00:00-05:00" - } - "@ - - # Create Non-Employee Record - - try { - $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - New-NonEmployeeRecord -NonEmployeeRequestBody $Result - - # Below is a request that includes all optional parameters - # New-NonEmployeeRecord -NonEmployeeRequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeRecord" - Write-Host $_.ErrorDetails - } - get: - operationId: listNonEmployeeRecords - security: - - userAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: List Non-Employee Records - description: |- - This gets a list of non-employee records. There are two contextual uses for this endpoint: - 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. - 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. - parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - example: accountName,sourceId - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** - - in: query - name: filters - required: false - schema: - type: string - example: sourceId eq "2c91808568c529c60168cca6f90c1313" - description: |- - 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* - responses: - '200': - description: Non-Employee record objects - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1non-employee-records/post/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeRecord.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#list-non-employee-records - source: | - $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) - $Sorters = "accountName,sourceId" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) - $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # 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: **sourceId**: *eq* (optional) - - # List Non-Employee Records - - try { - Get-NonEmployeeRecords - - # Below is a request that includes all optional parameters - # Get-NonEmployeeRecords -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRecords" - Write-Host $_.ErrorDetails - } - /non-employee-records/{id}: - get: - operationId: getNonEmployeeRecord - tags: - - Non-Employee Lifecycle Management - summary: Get a Non-Employee Record - description: |- - This gets a non-employee record. - Requires role context of `idn:nesr:read` - parameters: - - in: path - name: id - description: Non-Employee record id (UUID) - required: true - x-sailpoint-resource-operation-id: listNonEmployeeRecords - example: ef38f94347e94562b5bb8424a56397d8 - schema: - type: string - responses: - '200': - description: Non-Employee record object - content: - application/json: - schema: - $ref: '#/paths/~1non-employee-records/post/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeRecord.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#get-non-employee-record - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) - - # Get a Non-Employee Record - - try { - Get-NonEmployeeRecord -Id $Id - - # Below is a request that includes all optional parameters - # Get-NonEmployeeRecord -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRecord" - Write-Host $_.ErrorDetails - } - put: - operationId: updateNonEmployeeRecord - security: - - userAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: Update Non-Employee Record - description: |- - This request will update a non-employee record. There are two contextual uses for this endpoint: - 1. The user has the role context of `idn:nesr:update`, in which case they - update all available fields. - 2. The user is owner of the source, in this case they can only update the - end date. - parameters: - - in: path - name: id - description: Non-employee record id (UUID) - example: ef38f94347e94562b5bb8424a56397d8 - required: true - x-sailpoint-resource-operation-id: listNonEmployeeRecords - schema: - type: string - requestBody: - description: Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - required: true - content: - application/json: - schema: - $ref: '#/paths/~1non-employee-records/post/requestBody/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeRequestBody.yaml - responses: - '200': - description: An updated non-employee record. - content: - application/json: - schema: - $ref: '#/paths/~1non-employee-records/post/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeRecord.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#update-non-employee-record - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID) - $NonEmployeeRequestBody = @" - { - "sourceId" : "2c91808568c529c60168cca6f90c1313", - "firstName" : "William", - "lastName" : "Smith", - "manager" : "jane.doe", - "data" : { - "description" : "Auditing" - }, - "accountName" : "william.smith", - "phone" : "5125555555", - "endDate" : "2021-03-25T00:00:00-05:00", - "email" : "william.smith@example.com", - "startDate" : "2020-03-24T00:00:00-05:00" - } - "@ - - # Update Non-Employee Record - - try { - $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - Update-NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result - - # Below is a request that includes all optional parameters - # Update-NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeRecord" - Write-Host $_.ErrorDetails - } - patch: - operationId: patchNonEmployeeRecord - security: - - userAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: Patch Non-Employee Record - description: |- - This request will patch a non-employee record. There are two contextual uses for this endpoint: - 1. The user has the role context of `idn:nesr:update`, in which case they - update all available fields. - 2. The user is owner of the source, in this case they can only update the - end date. - parameters: - - in: path - name: id - description: Non-employee record id (UUID) - example: ef38f94347e94562b5bb8424a56397d8 - required: true - x-sailpoint-resource-operation-id: listNonEmployeeRecords - schema: - type: string - requestBody: - description: A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - required: true - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml - example: - - op: replace - path: /endDate - value: '2019-08-23T18:40:35.772Z' - responses: - '200': - description: A patched non-employee record. - content: - application/json: - schema: - $ref: '#/paths/~1non-employee-records/post/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeRecord.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#patch-non-employee-record - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID) - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Non-Employee Record - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-NonEmployeeRecord -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-NonEmployeeRecord -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeRecord" - Write-Host $_.ErrorDetails - } - delete: - operationId: deleteNonEmployeeRecord - tags: - - Non-Employee Lifecycle Management - summary: Delete Non-Employee Record - description: |- - This request will delete a non-employee record. - Requires role context of `idn:nesr:delete` - parameters: - - in: path - name: id - description: Non-Employee record id (UUID) - example: ef38f94347e94562b5bb8424a56397d8 - required: true - x-sailpoint-resource-operation-id: listNonEmployeeRecords - schema: - type: string - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#delete-non-employee-record - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) - - # Delete Non-Employee Record - - try { - Remove-NonEmployeeRecord -Id $Id - - # Below is a request that includes all optional parameters - # Remove-NonEmployeeRecord -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeRecord" - Write-Host $_.ErrorDetails - } - /non-employee-records/bulk-delete: - post: - operationId: deleteNonEmployeeRecordsInBulk - tags: - - Non-Employee Lifecycle Management - summary: Delete Multiple Non-Employee Records - description: This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` - requestBody: - description: Non-Employee bulk delete request body. - required: true - content: - application/json: - schema: - type: object - properties: - ids: - description: List of non-employee ids. - type: array - items: - type: string - format: uuid - example: - - 2b838de9-db9b-abcf-e646-d4f274ad4238 - - 2d838de9-db9b-abcf-e646-d4f274ad4238 - required: - - ids - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#delete-non-employee-records-in-bulk - source: | - $DeleteNonEmployeeRecordsInBulkRequest = @" - - "@ - - # Delete Multiple Non-Employee Records - - try { - $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordsInBulkRequest -Json $DeleteNonEmployeeRecordsInBulkRequest - Remove-NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $Result - - # Below is a request that includes all optional parameters - # Remove-NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeRecordsInBulk" - Write-Host $_.ErrorDetails - } - /non-employee-requests: - post: - operationId: createNonEmployeeRequest - security: - - userAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: Create Non-Employee Request - description: This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. - requestBody: - description: Non-Employee creation request body - required: true - content: - application/json: - schema: - $ref: '#/paths/~1non-employee-records/post/requestBody/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeRequestBody.yaml - responses: - '200': - description: Non-Employee request creation object - content: - application/json: - schema: - allOf: - - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee source id. - example: a0303682-5e4a-44f7-bdc2-6ce6112549c1 - sourceId: - type: string - description: Source Id associated with this non-employee source. - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Source name associated with this non-employee source. - example: Retail - description: - type: string - description: Source description associated with this non-employee source. - example: Source description - - type: object - properties: - accountName: - type: string - description: Requested identity account name. - example: william.smith - firstName: - type: string - description: Non-Employee's first name. - example: William - lastName: - type: string - description: Non-Employee's last name. - example: Smith - email: - type: string - description: Non-Employee's email. - example: william.smith@example.com - phone: - type: string - description: Non-Employee's phone. - example: '5125555555' - manager: - type: string - description: The account ID of a valid identity to serve as this non-employee's manager. - example: jane.doe - nonEmployeeSource: - $ref: '#/paths/~1non-employee-requests/post/responses/200/content/application~1json/schema/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeSourceLite.yaml - data: - type: object - additionalProperties: - type: string - description: Additional attributes for a non-employee. Up to 10 custom attributes can be added. - example: - description: Auditing - approvalItems: - description: List of approval item for the request - type: array - items: - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee approval item id - example: 2c1e388b-1e55-4b0a-ab5c-897f1204159c - approver: - $ref: '#/paths/~1non-employee-sources~1%7BsourceId%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/approvers/items' - description: Reference to the associated Identity - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeIdentityReferenceWithId.yaml - accountName: - type: string - description: Requested identity account name - example: test.account - approvalStatus: - $ref: '#/paths/~1non-employee-requests/post/responses/200/content/application~1json/schema/allOf/1/properties/approvalStatus' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/ApprovalStatus.yaml - approvalOrder: - type: number - description: Approval order - example: 1 - format: float - comment: - type: string - description: comment of approver - example: I approve - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - approvalStatus: - type: string - enum: - - APPROVED - - REJECTED - - PENDING - - NOT_READY - - CANCELLED - description: Enum representing the non-employee request approval status - example: APPROVED - comment: - type: string - description: Comment of requester - example: approved - completionDate: - type: string - format: date-time - description: When the request was completely approved. - example: '2020-03-24T11:11:41.139-05:00' - startDate: - type: string - format: date-time - description: Non-Employee employment start date. - example: '2020-03-24T00:00:00-05:00' - endDate: - type: string - format: date-time - description: Non-Employee employment end date. - example: '2021-03-25T00:00:00-05:00' - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2020-03-24T11:11:41.139-05:00' - created: - type: string - format: date-time - description: When the request was created. - example: '2020-03-24T11:11:41.139-05:00' - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ErrorResponseDto.yaml - examples: - 400.1 Bad Request Content: - description: Response for bad request content - value: - detailCode: 400.1 Bad Request Content - trackingId: e7eab60924f64aa284175b9fa3309599 - messages: - - locale: en - localeOrigin: REQUEST - text: firstName is required; accountName is required; - 400.1.409 Reference conflict: - description: Response for reference conflict - value: - detailCode: 400.1.409 Reference conflict - trackingId: e7eab60924f64aa284175b9fa3309599 - messages: - - locale: en - localeOrigin: REQUEST - text: Unable to create Non-Employee because the accountName "existed" is already being used. - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#create-non-employee-request - source: | - $NonEmployeeRequestBody = @" - { - "sourceId" : "2c91808568c529c60168cca6f90c1313", - "firstName" : "William", - "lastName" : "Smith", - "manager" : "jane.doe", - "data" : { - "description" : "Auditing" - }, - "accountName" : "william.smith", - "phone" : "5125555555", - "endDate" : "2021-03-25T00:00:00-05:00", - "email" : "william.smith@example.com", - "startDate" : "2020-03-24T00:00:00-05:00" - } - "@ - - # Create Non-Employee Request - - try { - $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - New-NonEmployeeRequest -NonEmployeeRequestBody $Result - - # Below is a request that includes all optional parameters - # New-NonEmployeeRequest -NonEmployeeRequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeRequest" - Write-Host $_.ErrorDetails - } - get: - operationId: listNonEmployeeRequests - security: - - userAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: List Non-Employee Requests - description: |- - This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: - 1. The user has the role context of `idn:nesr:read`, in which case he or - she may request a list non-employee requests assigned to a particular account manager by passing in that manager's id. - 2. The current user is an account manager, in which case "me" should be - provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages. - parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml - - in: query - name: requested-for - required: true - schema: - type: string - example: e136567de87e4d029e60b3c3c55db56d - description: The identity for whom the request was made. *me* indicates the current user. - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - example: created,approvalStatus - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** - - in: query - name: filters - required: false - schema: - type: string - example: sourceId eq "2c91808568c529c60168cca6f90c1313" - description: |- - 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* - responses: - '200': - description: List of non-employee request objects. - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1non-employee-requests/post/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeRequest.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#list-non-employee-requests - source: | - $RequestedFor = "e136567de87e4d029e60b3c3c55db56d" # String | The identity for whom the request was made. *me* indicates the current user. - $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) - $Sorters = "created,approvalStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) - $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # 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: **sourceId**: *eq* (optional) - - # List Non-Employee Requests - - try { - Get-NonEmployeeRequests -RequestedFor $RequestedFor - - # Below is a request that includes all optional parameters - # Get-NonEmployeeRequests -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRequests" - Write-Host $_.ErrorDetails - } - /non-employee-requests/{id}: - get: - operationId: getNonEmployeeRequest - security: - - userAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: Get a Non-Employee Request - description: |- - This gets a non-employee request. - There are two contextual uses for this endpoint: - 1. The user has the role context of `idn:nesr:read`, in this case the user - can get the non-employee request for any user. - 2. The user must be the owner of the non-employee request. - parameters: - - in: path - name: id - description: Non-Employee request id (UUID) - example: ac110005-7156-1150-8171-5b292e3e0084 - required: true - x-sailpoint-resource-operation-id: listNonEmployeeRequests - schema: - type: string - responses: - '200': - description: Non-Employee request object. - content: - application/json: - schema: - $ref: '#/paths/~1non-employee-requests/post/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeRequest.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#get-non-employee-request - source: | - $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id (UUID) - - # Get a Non-Employee Request - - try { - Get-NonEmployeeRequest -Id $Id - - # Below is a request that includes all optional parameters - # Get-NonEmployeeRequest -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRequest" - Write-Host $_.ErrorDetails - } - delete: - operationId: deleteNonEmployeeRequest - tags: - - Non-Employee Lifecycle Management - summary: Delete Non-Employee Request - description: |- - This request will delete a non-employee request. - Requires role context of `idn:nesr:delete` - parameters: - - in: path - name: id - description: Non-Employee request id in the UUID format - required: true - x-sailpoint-resource-operation-id: listNonEmployeeRequests - schema: - type: string - format: uuid - example: ac110005-7156-1150-8171-5b292e3e0084 - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#delete-non-employee-request - source: | - $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id in the UUID format - - # Delete Non-Employee Request - - try { - Remove-NonEmployeeRequest -Id $Id - - # Below is a request that includes all optional parameters - # Remove-NonEmployeeRequest -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeRequest" - Write-Host $_.ErrorDetails - } - /non-employee-requests/summary/{requested-for}: - get: - operationId: getNonEmployeeRequestSummary - security: - - userAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: Get Summary of Non-Employee Requests - description: |- - This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: - 1. The user has the role context of `idn:nesr:read`, in which case he or - she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager's id. - 2. The current user is an account manager, in which case "me" should be - provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. - parameters: - - in: path - name: requested-for - description: The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use "me" instead to indicate the current user. - required: true - x-sailpoint-resource-operation-id: listNonEmployeeRecords - schema: - type: string - format: uuid (if user is Org Admin) - example: 2c91808280430dfb0180431a59440460 - responses: - '200': - description: Non-Employee request summary object. - content: - application/json: - schema: - type: object - properties: - approved: - type: integer - description: The number of approved non-employee requests on all sources that *requested-for* user manages. - example: 2 - format: int32 - rejected: - type: integer - description: The number of rejected non-employee requests on all sources that *requested-for* user manages. - example: 2 - format: int32 - pending: - type: integer - description: The number of pending non-employee requests on all sources that *requested-for* user manages. - example: 2 - format: int32 - nonEmployeeCount: - type: integer - description: The number of non-employee records on all sources that *requested-for* user manages. - example: 2 - format: int32 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#get-non-employee-request-summary - source: | - $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. - - # Get Summary of Non-Employee Requests - - try { - Get-NonEmployeeRequestSummary -RequestedFor $RequestedFor - - # Below is a request that includes all optional parameters - # Get-NonEmployeeRequestSummary -RequestedFor $RequestedFor - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRequestSummary" - Write-Host $_.ErrorDetails - } - /non-employee-sources: - post: - operationId: createNonEmployeeSource - security: - - userAuth: - - idn:nelm:manage - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - Non-Employee Lifecycle Management - summary: Create Non-Employee Source - description: 'Create a non-employee source. ' - requestBody: - description: Non-Employee source creation request body. - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: Name of non-employee source. - example: Retail - description: - type: string - description: Description of non-employee source. - example: Source description - owner: - type: object - properties: - id: - type: string - format: UUID - description: Identity id. - example: 2c91808570313110017040b06f344ec9 - required: - - id - managementWorkgroup: - type: string - description: The ID for the management workgroup that contains source sub-admins - example: '123299' - approvers: - description: List of approvers. - type: array - items: - $ref: '#/paths/~1non-employee-sources/post/requestBody/content/application~1json/schema/properties/owner' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeIdnUserRequest.yaml - maxItems: 3 - accountManagers: - description: List of account managers. - type: array - items: - $ref: '#/paths/~1non-employee-sources/post/requestBody/content/application~1json/schema/properties/owner' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeIdnUserRequest.yaml - maxItems: 10 - required: - - owner - - name - - description - responses: - '200': - description: Created non-employee source. - content: - application/json: - schema: - allOf: - - $ref: '#/paths/~1non-employee-sources~1%7BsourceId%7D/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeSource.yaml - - type: object - properties: - cloudExternalId: - type: string - description: Legacy ID used for sources from the V1 API. This attribute will be removed from a future version of the API and will not be considered a breaking change. No clients should rely on this ID always being present. - example: '99999' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#create-non-employee-source - source: | - $NonEmployeeSourceRequestBody = @" - { - "owner" : { - "id" : "2c91808570313110017040b06f344ec9" - }, - "managementWorkgroup" : "123299", - "accountManagers" : [ { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - } ], - "name" : "Retail", - "description" : "Source description", - "approvers" : [ { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - } ] - } - "@ - - # Create Non-Employee Source - - try { - $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody - New-NonEmployeeSource -NonEmployeeSourceRequestBody $Result - - # Below is a request that includes all optional parameters - # New-NonEmployeeSource -NonEmployeeSourceRequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeSource" - Write-Host $_.ErrorDetails - } - get: - operationId: listNonEmployeeSources - security: - - userAuth: - - idn:nelm:read - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - Non-Employee Lifecycle Management - summary: List Non-Employee Sources - description: |- - Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: - 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager's `id`. - 2. If the current user is an account manager, the user should provide 'me' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. - parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml - - in: query - name: requested-for - required: false - schema: - type: string - example: me - description: Identity the request was made for. Use 'me' to indicate the current user. - - in: query - name: non-employee-count - required: false - example: true - schema: - type: boolean - default: false - description: Flag that determines whether the API will return a non-employee count associated with the source. - - in: query - name: sorters - required: false - schema: - type: string - format: comma-separated - example: name,created - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name, created, sourceId** - responses: - '200': - description: List of non-employee sources objects. - content: - application/json: - schema: - type: array - items: - allOf: - - $ref: '#/paths/~1non-employee-sources~1%7BsourceId%7D/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeSource.yaml - - type: object - properties: - nonEmployeeCount: - type: integer - description: Number of non-employee records associated with this source. This value is 'NULL' by default. To get the non-employee count, you must set the `non-employee-count` flag in your request to 'true'. - format: int32 - example: 120 - nullable: true - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#list-non-employee-sources - source: | - $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) - $RequestedFor = "me" # String | Identity the request was made for. Use 'me' to indicate the current user. (optional) - $NonEmployeeCount = $true # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false) - $Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) - - # List Non-Employee Sources - - try { - Get-NonEmployeeSources - - # Below is a request that includes all optional parameters - # Get-NonEmployeeSources -Limit $Limit -Offset $Offset -Count $Count -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSources" - Write-Host $_.ErrorDetails - } - /non-employee-sources/{sourceId}: - get: - operationId: getNonEmployeeSource - security: - - userAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: Get a Non-Employee Source - description: |- - This gets a non-employee source. There are two contextual uses for the requested-for path parameter: - 1. The user has the role context of `idn:nesr:read`, in which case he or - she may request any source. - 2. The current user is an account manager, in which case the user can only - request sources that they own. - parameters: - - in: path - name: sourceId - description: Source Id - example: 2c91808b7c28b350017c2a2ec5790aa1 - required: true - x-sailpoint-resource-operation-id: listNonEmployeeSources - schema: - type: string - responses: - '200': - description: Non-Employee source object. - content: - application/json: - schema: - allOf: - - $ref: '#/paths/~1non-employee-requests/post/responses/200/content/application~1json/schema/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeSourceLite.yaml - - type: object - properties: - approvers: - description: List of approvers - type: array - items: - type: object - properties: - type: - type: string - enum: - - GOVERNANCE_GROUP - - IDENTITY - example: IDENTITY - description: Identifies if the identity is a normal identity or a governance group - id: - type: string - description: Identity id - example: 5168015d32f890ca15812c9180835d2e - accountManagers: - description: List of account managers - type: array - items: - $ref: '#/paths/~1non-employee-sources~1%7BsourceId%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/approvers/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeIdentityReferenceWithId.yaml - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the request was created. - example: '2019-08-23T18:40:35.772Z' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#get-non-employee-source - source: | - $SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id - - # Get a Non-Employee Source - - try { - Get-NonEmployeeSource -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-NonEmployeeSource -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSource" - Write-Host $_.ErrorDetails - } - patch: - operationId: patchNonEmployeeSource - tags: - - Non-Employee Lifecycle Management - summary: Patch a Non-Employee Source - description: 'patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`.' - parameters: - - in: path - name: sourceId - description: Source Id - required: true - x-sailpoint-resource-operation-id: listNonEmployeeSources - schema: - type: string - example: e136567de87e4d029e60b3c3c55db56d - requestBody: - description: A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - required: true - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml - example: - - op: replace - path: /name - value: - new name: null - - op: replace - path: /approvers - value: - - 2c91809f703bb37a017040a2fe8748c7 - - 48b1f463c9e8427db5a5071bd81914b8 - responses: - '200': - description: A patched non-employee source object. - content: - application/json: - schema: - $ref: '#/paths/~1non-employee-sources~1%7BsourceId%7D/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeSource.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#patch-non-employee-source - source: | - $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a Non-Employee Source - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeSource" - Write-Host $_.ErrorDetails - } - delete: - operationId: deleteNonEmployeeSource - tags: - - Non-Employee Lifecycle Management - summary: Delete Non-Employee Source - description: This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. - parameters: - - in: path - name: sourceId - description: Source Id - required: true - x-sailpoint-resource-operation-id: listNonEmployeeSources - schema: - type: string - example: e136567de87e4d029e60b3c3c55db56d - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#delete-non-employee-source - source: | - $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id - - # Delete Non-Employee Source - - try { - Remove-NonEmployeeSource -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Remove-NonEmployeeSource -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeSource" - Write-Host $_.ErrorDetails - } - /non-employee-sources/{id}/non-employees/download: - get: - operationId: exportNonEmployeeRecords - tags: - - Non-Employee Lifecycle Management - summary: Exports Non-Employee Records to CSV - description: This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` - parameters: - - in: path - name: id - description: Source Id (UUID) - required: true - x-sailpoint-resource-operation-id: listNonEmployeeSources - schema: - type: string - example: e136567de87e4d029e60b3c3c55db56d - responses: - '200': - description: Exported CSV - content: - text/csv: - example: | - accountName,firstName,lastName,phone,email,manager,startDate,endDate - Jon.Smith, Jon, Smith, 555-555-5555, jon@jon.doe.nope.com, Jim Smith, 2020-04-05T08:00:00-10:00,2020-08-07T19:00:00-10:00 - William.Chaffin, William, Chaffin, 555-555-5555, william@chaffins.nope.com, Bertram Chaffin, 2020-04-05T08:00:00-10:00,2020-08-07T19:00:00-10:00 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#export-non-employee-records - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) - - # Exports Non-Employee Records to CSV - - try { - Export-NonEmployeeRecords -Id $Id - - # Below is a request that includes all optional parameters - # Export-NonEmployeeRecords -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-NonEmployeeRecords" - Write-Host $_.ErrorDetails - } - /non-employee-sources/{id}/non-employee-bulk-upload: - post: - operationId: importNonEmployeeRecordsInBulk - security: - - userAuth: - - idn:nelm:manage - tags: - - Non-Employee Lifecycle Management - summary: Imports, or Updates, Non-Employee Records - description: This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` - parameters: - - in: path - name: id - description: Source Id (UUID) - required: true - x-sailpoint-resource-operation-id: listNonEmployeeSources - schema: - type: string - example: e136567de87e4d029e60b3c3c55db56d - requestBody: - content: - multipart/form-data: - schema: - type: object - properties: - data: - type: string - format: binary - required: - - data - responses: - '202': - description: The CSV was accepted to be bulk inserted now or at a later time. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: The bulk upload job's ID. (UUID) - example: 2c91808568c529c60168cca6f90cffff - sourceId: - type: string - description: The ID of the source to bulk-upload non-employees to. (UUID) - example: 2c91808568c529c60168cca6f90c1313 - created: - type: string - format: date-time - description: The date-time the job was submitted. - example: '2019-08-23T18:52:59.162Z' - modified: - type: string - format: date-time - description: The date-time that the job was last updated. - example: '2019-08-23T18:52:59.162Z' - status: - type: string - enum: - - PENDING - - IN_PROGRESS - - COMPLETED - - ERROR - description: | - Returns the following values indicating the progress or result of the bulk upload job. - "PENDING" means the job is queued and waiting to be processed. - "IN_PROGRESS" means the job is currently being processed. - "COMPLETED" means the job has been completed without any errors. - "ERROR" means the job failed to process with errors. - example: PENDING - '400': - description: | - Client Error - Returned if the request body is invalid. - The response body will contain the list of specific errors with one on each line. - content: - application/json: - schema: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ErrorResponseDto.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#import-non-employee-records-in-bulk - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) - $Data = # System.IO.FileInfo | - - # Imports, or Updates, Non-Employee Records - - try { - Import-NonEmployeeRecordsInBulk -Id $Id -Data $Data - - # Below is a request that includes all optional parameters - # Import-NonEmployeeRecordsInBulk -Id $Id -Data $Data - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-NonEmployeeRecordsInBulk" - Write-Host $_.ErrorDetails - } - /non-employee-sources/{id}/non-employee-bulk-upload/status: - get: - operationId: getNonEmployeeBulkUploadStatus - tags: - - Non-Employee Lifecycle Management - summary: Obtain the status of bulk upload on the source - description: | - The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. - Requires role context of `idn:nesr:read` - parameters: - - in: path - name: id - description: Source ID (UUID) - required: true - x-sailpoint-resource-operation-id: listNonEmployeeSources - schema: - type: string - example: e136567de87e4d029e60b3c3c55db56d - responses: - '200': - description: Status of the newest bulk-upload job, if any. - content: - application/json: - schema: - type: object - properties: - status: - type: string - enum: - - PENDING - - IN_PROGRESS - - COMPLETED - - ERROR - description: | - Returns the following values indicating the progress or result of the bulk upload job. - "PENDING" means the job is queued and waiting to be processed. - "IN_PROGRESS" means the job is currently being processed. - "COMPLETED" means the job has been completed without any errors. - "ERROR" means the job failed to process with errors. - null means job has been submitted to the source. - example: PENDING - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#get-non-employee-bulk-upload-status - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source ID (UUID) - - # Obtain the status of bulk upload on the source - - try { - Get-NonEmployeeBulkUploadStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-NonEmployeeBulkUploadStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeBulkUploadStatus" - Write-Host $_.ErrorDetails - } - /non-employee-sources/{id}/schema-attributes-template/download: - get: - operationId: exportNonEmployeeSourceSchemaTemplate - tags: - - Non-Employee Lifecycle Management - summary: Exports Source Schema Template - description: This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` - parameters: - - in: path - name: id - description: Source Id (UUID) - required: true - x-sailpoint-resource-operation-id: listNonEmployeeSources - example: ef38f94347e94562b5bb8424a56397d8 - schema: - type: string - responses: - '200': - description: Exported Source Schema Template - content: - text/csv: - example: | - accountName,firstName,lastName,phone,email,manager,startDate,endDate - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#export-non-employee-source-schema-template - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id (UUID) - - # Exports Source Schema Template - - try { - Export-NonEmployeeSourceSchemaTemplate -Id $Id - - # Below is a request that includes all optional parameters - # Export-NonEmployeeSourceSchemaTemplate -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-NonEmployeeSourceSchemaTemplate" - Write-Host $_.ErrorDetails - } - /non-employee-approvals: - get: - operationId: listNonEmployeeApprovals - security: - - userAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: Get List of Non-Employee Approval Requests - description: |- - This gets a list of non-employee approval requests. - There are two contextual uses for this endpoint: - 1. The user has the role context of `idn:nesr:read`, in which case they - can list the approvals for any approver. - 2. The user owns the requested approval. - parameters: - - in: query - name: requested-for - schema: - type: string - description: The identity for whom the request was made. *me* indicates the current user. - required: false - example: 2c91808280430dfb0180431a59440460 - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml - - in: query - name: filters - schema: - type: string - description: |- - 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: - - **approvalStatus**: *eq* - example: approvalStatus eq "Pending" - required: false - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **created, modified** - required: false - example: created - responses: - '200': - description: List of approval items. - content: - application/json: - schema: - type: array - items: - allOf: - - $ref: '#/paths/~1non-employee-requests/post/responses/200/content/application~1json/schema/allOf/1/properties/approvalItems/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeApprovalItemBase.yaml - - type: object - properties: - nonEmployeeRequest: - type: object - properties: - id: - type: string - format: UUID - description: Non-Employee request id. - example: ac110005-7156-1150-8171-5b292e3e0084 - requester: - $ref: '#/paths/~1non-employee-sources~1%7BsourceId%7D/get/responses/200/content/application~1json/schema/allOf/1/properties/approvers/items' - example: - type: IDENTITY - id: 2c9180866166b5b0016167c32ef31a66 - name: William Smith - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeIdentityReferenceWithId.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#list-non-employee-approvals - source: | - $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity for whom the request was made. *me* indicates the current user. (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) - $Filters = "approvalStatus eq "Pending"" # 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: **approvalStatus**: *eq* (optional) - $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - - # Get List of Non-Employee Approval Requests - - try { - Get-NonEmployeeApprovals - - # Below is a request that includes all optional parameters - # Get-NonEmployeeApprovals -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeApprovals" - Write-Host $_.ErrorDetails - } - /non-employee-approvals/{id}: - get: - operationId: getNonEmployeeApproval - security: - - userAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: Get a non-employee approval item detail - description: |- - Gets a non-employee approval item detail. There are two contextual uses for this endpoint: - 1. The user has the role context of `idn:nesr:read`, in which case they - can get any approval. - 2. The user owns the requested approval. - parameters: - - in: path - name: id - description: Non-Employee approval item id (UUID) - required: true - x-sailpoint-resource-operation-id: listNonEmployeeApprovals - schema: - type: string - example: e136567de87e4d029e60b3c3c55db56d - - in: query - name: include-detail - description: The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* - required: false - schema: - type: boolean - example: true - responses: - '200': - description: Non-Employee approval item object. - content: - application/json: - schema: - allOf: - - $ref: '#/paths/~1non-employee-requests/post/responses/200/content/application~1json/schema/allOf/1/properties/approvalItems/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeApprovalItemBase.yaml - - type: object - properties: - nonEmployeeRequest: - allOf: - - $ref: '#/paths/~1non-employee-approvals/get/responses/200/content/application~1json/schema/items/allOf/1/properties/nonEmployeeRequest' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeRequestLite.yaml - - type: object - properties: - accountName: - type: string - description: Requested identity account name. - example: william.smith - firstName: - type: string - description: Non-Employee's first name. - example: William - lastName: - type: string - description: Non-Employee's last name. - example: Smith - email: - type: string - description: Non-Employee's email. - example: william.smith@example.com - phone: - type: string - description: Non-Employee's phone. - example: '5125555555' - manager: - type: string - description: The account ID of a valid identity to serve as this non-employee's manager. - example: jane.doe - nonEmployeeSource: - allOf: - - $ref: '#/paths/~1non-employee-requests/post/responses/200/content/application~1json/schema/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeSourceLite.yaml - - type: object - properties: - schemaAttributes: - description: List of schema attributes associated with this non-employee source. - type: array - items: - $ref: '#/paths/~1non-employee-sources~1%7BsourceId%7D~1schema-attributes/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeSchemaAttribute.yaml - data: - type: object - additionalProperties: - type: string - description: Additional attributes for a non-employee. Up to 10 custom attributes can be added. - example: - description: Auditing - approvalStatus: - $ref: '#/paths/~1non-employee-requests/post/responses/200/content/application~1json/schema/allOf/1/properties/approvalStatus' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/ApprovalStatus.yaml - comment: - type: string - description: Comment of requester - example: approved - completionDate: - type: string - format: date-time - description: When the request was completely approved. - example: '2020-03-24T11:11:41.139-05:00' - startDate: - type: string - format: date - description: Non-Employee employment start date. - example: '2020-03-24' - endDate: - type: string - format: date - description: Non-Employee employment end date. - example: '2021-03-25' - modified: - type: string - format: date-time - description: When the request was last modified. - example: '2020-03-24T11:11:41.139-05:00' - created: - type: string - format: date-time - description: When the request was created. - example: '2020-03-24T11:11:41.139-05:00' - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#get-non-employee-approval - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) - $IncludeDetail = $true # Boolean | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) - - # Get a non-employee approval item detail - - try { - Get-NonEmployeeApproval -Id $Id - - # Below is a request that includes all optional parameters - # Get-NonEmployeeApproval -Id $Id -IncludeDetail $IncludeDetail - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeApproval" - Write-Host $_.ErrorDetails - } - /non-employee-approvals/{id}/approve: - post: - operationId: approveNonEmployeeRequest - security: - - userAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: Approve a Non-Employee Request - description: Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. - parameters: - - in: path - name: id - description: Non-Employee approval item id (UUID) - required: true - x-sailpoint-resource-operation-id: listNonEmployeeApprovals - schema: - type: string - example: e136567de87e4d029e60b3c3c55db56d - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - comment: - type: string - description: Comment on the approval item. - maxLength: 4000 - example: Approved by manager - responses: - '200': - description: Non-Employee approval item object. - content: - application/json: - schema: - $ref: '#/paths/~1non-employee-approvals/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeApprovalItem.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#approve-non-employee-request - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) - $NonEmployeeApprovalDecision = @" - { - "comment" : "Approved by manager" - } - "@ - - # Approve a Non-Employee Request - - try { - $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision - Approve-NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result - - # Below is a request that includes all optional parameters - # Approve-NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-NonEmployeeRequest" - Write-Host $_.ErrorDetails - } - /non-employee-approvals/{id}/reject: - post: - operationId: rejectNonEmployeeRequest - security: - - userAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: Reject a Non-Employee Request - description: This endpoint will reject an approval item request and notify user. The current user must be the requested approver. - parameters: - - in: path - name: id - description: Non-Employee approval item id (UUID) - required: true - x-sailpoint-resource-operation-id: listNonEmployeeApprovals - schema: - type: string - example: e136567de87e4d029e60b3c3c55db56d - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - comment: - type: string - description: Comment on the approval item. - maxLength: 4000 - example: approved - required: - - comment - responses: - '200': - description: Non-Employee approval item object. - content: - application/json: - schema: - $ref: '#/paths/~1non-employee-approvals/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeApprovalItem.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#reject-non-employee-request - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) - $NonEmployeeRejectApprovalDecision = @" - { - "comment" : "approved" - } - "@ - - # Reject a Non-Employee Request - - try { - $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision - Deny-NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result - - # Below is a request that includes all optional parameters - # Deny-NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-NonEmployeeRequest" - Write-Host $_.ErrorDetails - } - /non-employee-approvals/summary/{requested-for}: - get: - operationId: getNonEmployeeApprovalSummary - security: - - userAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: Get Summary of Non-Employee Approval Requests - description: |- - This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: - 1. The user has the role context of `idn:nesr:read`, in which case he or - she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver's id. - 2. The current user is an approver, in which case "me" should be provided - as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. - parameters: - - in: path - name: requested-for - schema: - type: string - description: The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use "me" instead to indicate the current user. - required: true - x-sailpoint-resource-operation-id: listIdentities - example: 2c91808280430dfb0180431a59440460 - responses: - '200': - description: summary of non-employee approval requests - content: - application/json: - schema: - type: object - properties: - approved: - type: integer - description: The number of approved non-employee approval requests. - format: int32 - example: 2 - pending: - type: integer - description: The number of pending non-employee approval requests. - format: int32 - example: 2 - rejected: - type: integer - description: The number of rejected non-employee approval requests. - format: int32 - example: 2 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#get-non-employee-approval-summary - source: | - $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. - - # Get Summary of Non-Employee Approval Requests - - try { - Get-NonEmployeeApprovalSummary -RequestedFor $RequestedFor - - # Below is a request that includes all optional parameters - # Get-NonEmployeeApprovalSummary -RequestedFor $RequestedFor - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeApprovalSummary" - Write-Host $_.ErrorDetails - } - /non-employee-sources/{sourceId}/schema-attributes: - get: - operationId: getNonEmployeeSourceSchemaAttributes - security: - - userAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: List Schema Attributes Non-Employee Source - description: |- - This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. - Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - parameters: - - in: path - name: sourceId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listNonEmployeeSources - example: ef38f94347e94562b5bb8424a56397d8 - description: The Source id - responses: - '200': - description: A list of Schema Attributes - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - format: UUID - example: ac110005-7156-1150-8171-5b292e3e0084 - description: Schema Attribute Id - system: - type: boolean - description: True if this schema attribute is mandatory on all non-employees sources. - example: true - default: false - modified: - type: string - format: date-time - description: When the schema attribute was last modified. - example: '2019-08-23T18:52:59.162Z' - created: - type: string - format: date-time - description: When the schema attribute was created. - example: '2019-08-23T18:40:35.772Z' - type: - type: string - enum: - - TEXT - - DATE - - IDENTITY - description: Enum representing the type of data a schema attribute accepts. - example: TEXT - label: - type: string - description: Label displayed on the UI for this schema attribute. - example: Account Name - technicalName: - type: string - description: The technical name of the attribute. Must be unique per source. - example: account.name - helpText: - type: string - description: help text displayed by UI. - example: The unique identifier for the account - placeholder: - type: string - description: Hint text that fills UI box. - example: Enter a unique user name for this account. - required: - type: boolean - description: If true, the schema attribute is required for all non-employees in the source - example: true - default: false - required: - - type - - technicalName - - label - maxItems: 18 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#get-non-employee-source-schema-attributes - source: | - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - - # List Schema Attributes Non-Employee Source - - try { - Get-NonEmployeeSourceSchemaAttributes -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-NonEmployeeSourceSchemaAttributes -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSourceSchemaAttributes" - Write-Host $_.ErrorDetails - } - post: - operationId: createNonEmployeeSourceSchemaAttributes - tags: - - Non-Employee Lifecycle Management - summary: Create a new Schema Attribute for Non-Employee Source - description: |- - This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a "400.1.409 Reference conflict" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a "400.1.4 Limit violation" response. - Requires role context of `idn:nesr:create` - parameters: - - in: path - name: sourceId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listNonEmployeeSources - description: The Source id - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - type: - type: string - description: Type of the attribute. Only type 'TEXT' is supported for custom attributes. - example: TEXT - label: - type: string - description: Label displayed on the UI for this schema attribute. - example: Account Name - technicalName: - type: string - description: The technical name of the attribute. Must be unique per source. - example: account.name - helpText: - type: string - description: help text displayed by UI. - example: The unique identifier for the account - placeholder: - type: string - description: Hint text that fills UI box. - example: Enter a unique user name for this account. - required: - type: boolean - description: If true, the schema attribute is required for all non-employees in the source - example: true - required: - - type - - technicalName - - label - responses: - '200': - description: Schema Attribute created. - content: - application/json: - schema: - $ref: '#/paths/~1non-employee-sources~1%7BsourceId%7D~1schema-attributes/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeSchemaAttribute.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes - source: | - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - $NonEmployeeSchemaAttributeBody = @" - { - "helpText" : "The unique identifier for the account", - "label" : "Account Name", - "placeholder" : "Enter a unique user name for this account.", - "type" : "TEXT", - "technicalName" : "account.name", - "required" : true - } - "@ - - # Create a new Schema Attribute for Non-Employee Source - - try { - $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody - New-NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result - - # Below is a request that includes all optional parameters - # New-NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeSourceSchemaAttributes" - Write-Host $_.ErrorDetails - } - delete: - operationId: deleteNonEmployeeSourceSchemaAttributes - tags: - - Non-Employee Lifecycle Management - summary: Delete all custom schema attributes for Non-Employee Source - description: This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` - parameters: - - in: path - name: sourceId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listNonEmployeeSources - description: The Source id - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#delete-non-employee-source-schema-attributes - source: | - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - - # Delete all custom schema attributes for Non-Employee Source - - try { - Remove-NonEmployeeSourceSchemaAttributes -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Remove-NonEmployeeSourceSchemaAttributes -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeSourceSchemaAttributes" - Write-Host $_.ErrorDetails - } - /non-employee-sources/{sourceId}/schema-attributes/{attributeId}: - get: - operationId: getNonEmployeeSchemaAttribute - security: - - userAuth: [] - tags: - - Non-Employee Lifecycle Management - summary: Get Schema Attribute Non-Employee Source - description: This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. - parameters: - - in: path - name: attributeId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getNonEmployeeSourceSchemaAttributes - example: ef38f94347e94562b5bb8424a56397d8 - description: The Schema Attribute Id (UUID) - - in: path - name: sourceId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listNonEmployeeSources - example: ef38f94347e94562b5bb8424a56397d8 - description: The Source id - responses: - '200': - description: The Schema Attribute - content: - application/json: - schema: - $ref: '#/paths/~1non-employee-sources~1%7BsourceId%7D~1schema-attributes/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeSchemaAttribute.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#get-non-employee-schema-attribute - source: | - $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - - # Get Schema Attribute Non-Employee Source - - try { - Get-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSchemaAttribute" - Write-Host $_.ErrorDetails - } - patch: - operationId: patchNonEmployeeSchemaAttribute - tags: - - Non-Employee Lifecycle Management - summary: Patch a Schema Attribute for Non-Employee Source - description: | - This end-point patches a specific schema attribute for a non-employee SourceId. - Requires role context of `idn:nesr:update` - parameters: - - in: path - name: attributeId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getNonEmployeeSourceSchemaAttributes - description: The Schema Attribute Id (UUID) - example: ef38f94347e94562b5bb8424a56397d8 - - in: path - name: sourceId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listNonEmployeeSources - description: The Source id - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - description: A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'. - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml - example: - - op: replace - path: /label - value: - new attribute label: null - required: true - responses: - '200': - description: The Schema Attribute was successfully patched. - content: - application/json: - schema: - $ref: '#/paths/~1non-employee-sources~1%7BsourceId%7D~1schema-attributes/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/non-employee/NonEmployeeSchemaAttribute.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#patch-non-employee-schema-attribute - source: | - $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a Schema Attribute for Non-Employee Source - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeSchemaAttribute" - Write-Host $_.ErrorDetails - } - delete: - operationId: deleteNonEmployeeSchemaAttribute - tags: - - Non-Employee Lifecycle Management - summary: Delete a Schema Attribute for Non-Employee Source - description: | - This end-point deletes a specific schema attribute for a non-employee source. - Requires role context of `idn:nesr:delete` - parameters: - - in: path - name: attributeId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getNonEmployeeSourceSchemaAttributes - description: The Schema Attribute Id (UUID) - example: ef38f94347e94562b5bb8424a56397d8 - - in: path - name: sourceId - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listNonEmployeeSources - description: The Source id - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#delete-non-employee-schema-attribute - source: | - $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) - $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - - # Delete a Schema Attribute for Non-Employee Source - - try { - Remove-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Remove-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeSchemaAttribute" - Write-Host $_.ErrorDetails - } - /oauth-clients: - get: - operationId: listOauthClients - security: - - userAuth: - - sp:oauth-client:manage - tags: - - OAuth Clients - summary: List OAuth Clients - description: This gets a list of OAuth clients. - parameters: - - in: query - name: filters - required: false - schema: - type: string - description: |- - 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: - - **lastUsed**: *le, isnull* - example: lastUsed le 2023-02-05T10:59:27.214Z - responses: - '200': - description: List of OAuth clients. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: ID of the OAuth client - example: 2c9180835d2e5168015d32f890ca1581 - businessName: - type: string - nullable: true - description: The name of the business the API Client should belong to - example: Acme-Solar - homepageUrl: - type: string - nullable: true - description: The homepage URL associated with the owner of the API Client - example: http://localhost:12345 - name: - type: string - description: A human-readable name for the API Client - example: Demo API Client - description: - type: string - nullable: true - description: A description of the API Client - example: An API client used for the authorization_code, refresh_token, and client_credentials flows - accessTokenValiditySeconds: - type: integer - format: int32 - description: The number of seconds an access token generated for this API Client is valid for - example: 750 - refreshTokenValiditySeconds: - type: integer - format: int32 - description: The number of seconds a refresh token generated for this API Client is valid for - example: 86400 - redirectUris: - type: array - nullable: true - items: - type: string - description: A list of the approved redirect URIs used with the authorization_code flow - example: - - http://localhost:12345 - grantTypes: - type: array - items: - description: OAuth2 Grant Type - type: string - example: CLIENT_CREDENTIALS - enum: - - CLIENT_CREDENTIALS - - AUTHORIZATION_CODE - - REFRESH_TOKEN - description: A list of OAuth 2.0 grant types this API Client can be used with - example: - - AUTHORIZATION_CODE - - CLIENT_CREDENTIALS - - REFRESH_TOKEN - accessType: - type: string - enum: - - ONLINE - - OFFLINE - description: Access type of API Client indicating online or offline use - example: OFFLINE - type: - type: string - enum: - - CONFIDENTIAL - - PUBLIC - description: Type of an API Client indicating public or confidentials use - example: CONFIDENTIAL - internal: - type: boolean - description: An indicator of whether the API Client can be used for requests internal to IDN - example: false - enabled: - type: boolean - description: An indicator of whether the API Client is enabled for use - example: true - strongAuthSupported: - type: boolean - description: An indicator of whether the API Client supports strong authentication - example: false - claimsSupported: - type: boolean - description: An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow - example: false - created: - type: string - format: date-time - description: The date and time, down to the millisecond, when the API Client was created - example: '2017-07-11T18:45:37.098Z' - modified: - type: string - format: date-time - description: The date and time, down to the millisecond, when the API Client was last updated - example: '2018-06-25T20:22:28.104Z' - secret: - type: string - nullable: true - metadata: - type: string - nullable: true - lastUsed: - type: string - nullable: true - format: date-time - description: The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed. - example: '2017-07-11T18:45:37.098Z' - scope: - type: array - nullable: true - items: - type: string - default: sp:scopes:all - description: Scopes of the API Client. - example: - - demo:api-client-scope:first - - demo:api-client-scope:second - required: - - id - - businessName - - homepageUrl - - name - - description - - accessTokenValiditySeconds - - refreshTokenValiditySeconds - - redirectUris - - grantTypes - - accessType - - type - - internal - - enabled - - strongAuthSupported - - claimsSupported - - created - - modified - - scope - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/o-auth-clients#list-oauth-clients - source: | - $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # 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: **lastUsed**: *le, isnull* (optional) - - # List OAuth Clients - - try { - Get-OauthClients - - # Below is a request that includes all optional parameters - # Get-OauthClients -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-OauthClients" - Write-Host $_.ErrorDetails - } - post: - operationId: createOauthClient - security: - - userAuth: - - sp:oauth-client:manage - tags: - - OAuth Clients - summary: Create OAuth Client - description: This creates an OAuth client. - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - businessName: - type: string - nullable: true - description: The name of the business the API Client should belong to - example: Acme-Solar - homepageUrl: - type: string - nullable: true - description: The homepage URL associated with the owner of the API Client - example: http://localhost:12345 - name: - type: string - nullable: true - description: A human-readable name for the API Client - example: Demo API Client - description: - type: string - nullable: true - description: A description of the API Client - example: An API client used for the authorization_code, refresh_token, and client_credentials flows - accessTokenValiditySeconds: - description: The number of seconds an access token generated for this API Client is valid for - type: integer - format: int32 - example: 750 - refreshTokenValiditySeconds: - description: The number of seconds a refresh token generated for this API Client is valid for - example: 86400 - type: integer - format: int32 - redirectUris: - type: array - nullable: true - items: - type: string - description: A list of the approved redirect URIs. Provide one or more URIs when assigning the AUTHORIZATION_CODE grant type to a new OAuth Client. - example: - - http://localhost:12345 - grantTypes: - type: array - nullable: true - items: - $ref: '#/paths/~1oauth-clients/get/responses/200/content/application~1json/schema/items/properties/grantTypes/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/GrantType.yaml - description: A list of OAuth 2.0 grant types this API Client can be used with - example: - - AUTHORIZATION_CODE - - CLIENT_CREDENTIALS - - REFRESH_TOKEN - accessType: - $ref: '#/paths/~1oauth-clients/get/responses/200/content/application~1json/schema/items/properties/accessType' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/AccessType.yaml - type: - $ref: '#/paths/~1oauth-clients/get/responses/200/content/application~1json/schema/items/properties/type' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ClientType.yaml - internal: - type: boolean - description: An indicator of whether the API Client can be used for requests internal within the product. - example: false - enabled: - type: boolean - description: An indicator of whether the API Client is enabled for use - example: true - strongAuthSupported: - type: boolean - description: An indicator of whether the API Client supports strong authentication - example: false - claimsSupported: - type: boolean - description: An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow - example: false - scope: - type: array - nullable: true - items: - type: string - default: sp:scopes:all - description: Scopes of the API Client. If no scope is specified, the client will be created with the default scope "sp:scopes:all". This means the API Client will have all the rights of the owner who created it. - example: - - demo:api-client-scope:first - - demo:api-client-scope:second - required: - - name - - description - - accessTokenValiditySeconds - - grantTypes - - accessType - - enabled - responses: - '200': - description: Request succeeded. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: ID of the OAuth client - example: 2c9180835d2e5168015d32f890ca1581 - secret: - type: string - description: Secret of the OAuth client (This field is only returned on the intial create call.) - example: 5c32dd9b21adb51c77794d46e71de117a1d0ddb36a7ff941fa28014ab7de2cf3 - businessName: - type: string - description: The name of the business the API Client should belong to - example: Acme-Solar - homepageUrl: - type: string - description: The homepage URL associated with the owner of the API Client - example: http://localhost:12345 - name: - type: string - description: A human-readable name for the API Client - example: Demo API Client - description: - type: string - description: A description of the API Client - example: An API client used for the authorization_code, refresh_token, and client_credentials flows - accessTokenValiditySeconds: - description: The number of seconds an access token generated for this API Client is valid for - example: 750 - type: integer - format: int32 - refreshTokenValiditySeconds: - description: The number of seconds a refresh token generated for this API Client is valid for - example: 86400 - type: integer - format: int32 - redirectUris: - type: array - items: - type: string - description: A list of the approved redirect URIs used with the authorization_code flow - example: - - http://localhost:12345 - grantTypes: - type: array - items: - $ref: '#/paths/~1oauth-clients/get/responses/200/content/application~1json/schema/items/properties/grantTypes/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/GrantType.yaml - description: A list of OAuth 2.0 grant types this API Client can be used with - example: - - AUTHORIZATION_CODE - - CLIENT_CREDENTIALS - - REFRESH_TOKEN - accessType: - $ref: '#/paths/~1oauth-clients/get/responses/200/content/application~1json/schema/items/properties/accessType' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/AccessType.yaml - type: - $ref: '#/paths/~1oauth-clients/get/responses/200/content/application~1json/schema/items/properties/type' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ClientType.yaml - internal: - type: boolean - description: An indicator of whether the API Client can be used for requests internal to IDN - example: false - enabled: - type: boolean - description: An indicator of whether the API Client is enabled for use - example: true - strongAuthSupported: - type: boolean - description: An indicator of whether the API Client supports strong authentication - example: false - claimsSupported: - type: boolean - description: An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow - example: false - created: - type: string - format: date-time - description: The date and time, down to the millisecond, when the API Client was created - example: '2017-07-11T18:45:37.098Z' - modified: - type: string - format: date-time - description: The date and time, down to the millisecond, when the API Client was last updated - example: '2018-06-25T20:22:28.104Z' - scope: - type: array - nullable: true - items: - type: string - default: sp:scopes:all - description: Scopes of the API Client. - example: - - demo:api-client-scope:first - - demo:api-client-scope:second - required: - - id - - secret - - businessName - - homepageUrl - - name - - description - - accessTokenValiditySeconds - - refreshTokenValiditySeconds - - redirectUris - - grantTypes - - accessType - - type - - internal - - enabled - - strongAuthSupported - - claimsSupported - - created - - modified - - scope - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/o-auth-clients#create-oauth-client - source: | - $CreateOAuthClientRequest = @" - { - "internal" : false, - "businessName" : "Acme-Solar", - "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", - "refreshTokenValiditySeconds" : 86400, - "type" : "CONFIDENTIAL", - "redirectUris" : [ "http://localhost:12345" ], - "enabled" : true, - "accessType" : "OFFLINE", - "grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ], - "strongAuthSupported" : false, - "homepageUrl" : "http://localhost:12345", - "accessTokenValiditySeconds" : 750, - "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], - "name" : "Demo API Client", - "claimsSupported" : false - } - "@ - - # Create OAuth Client - - try { - $Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest - New-OauthClient -CreateOAuthClientRequest $Result - - # Below is a request that includes all optional parameters - # New-OauthClient -CreateOAuthClientRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-OauthClient" - Write-Host $_.ErrorDetails - } - /oauth-clients/{id}: - get: - operationId: getOauthClient - security: - - userAuth: - - sp:oauth-client:manage - - sp:oauth-client:read - tags: - - OAuth Clients - summary: Get OAuth Client - description: This gets details of an OAuth client. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listOauthClients - description: The OAuth client id - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '200': - description: Request succeeded. - content: - application/json: - schema: - $ref: '#/paths/~1oauth-clients/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/GetOAuthClientResponse.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/o-auth-clients#get-oauth-client - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id - - # Get OAuth Client - - try { - Get-OauthClient -Id $Id - - # Below is a request that includes all optional parameters - # Get-OauthClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-OauthClient" - Write-Host $_.ErrorDetails - } - delete: - operationId: deleteOauthClient - security: - - userAuth: - - sp:oauth-client:manage - tags: - - OAuth Clients - summary: Delete OAuth Client - description: This deletes an OAuth client. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listOauthClients - description: The OAuth client id - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '204': - description: No content. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/o-auth-clients#delete-oauth-client - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id - - # Delete OAuth Client - - try { - Remove-OauthClient -Id $Id - - # Below is a request that includes all optional parameters - # Remove-OauthClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-OauthClient" - Write-Host $_.ErrorDetails - } - patch: - operationId: patchOauthClient - security: - - userAuth: - - sp:oauth-client:manage - tags: - - OAuth Clients - summary: Patch OAuth Client - description: This performs a targeted update to the field(s) of an OAuth client. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listOauthClients - description: The OAuth client id - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - description: | - A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - The following fields are patchable: - * tenant - * businessName - * homepageUrl - * name - * description - * accessTokenValiditySeconds - * refreshTokenValiditySeconds - * redirectUris - * grantTypes - * accessType - * enabled - * strongAuthSupported - * claimsSupported - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml - example: - - op: replace - path: /strongAuthSupported - value: true - - op: replace - path: /businessName - value: acme-solar - responses: - '200': - description: Indicates the PATCH operation succeeded, and returns the OAuth client's new representation. - content: - application/json: - schema: - $ref: '#/paths/~1oauth-clients/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/GetOAuthClientResponse.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/o-auth-clients#patch-oauth-client - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch OAuth Client - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-OauthClient -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-OauthClient -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-OauthClient" - Write-Host $_.ErrorDetails - } - /password-sync-groups: - get: - operationId: getPasswordSyncGroups - tags: - - Password Sync Groups - summary: Get Password Sync Group List - description: This API returns a list of password sync groups. - security: - - userAuth: - - idn:password-sync-group-management:read - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml - responses: - '200': - description: A list of password sync groups. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: ID of the sync group - example: 6881f631-3bd5-4213-9c75-8e05cc3e35dd - name: - description: Name of the sync group - type: string - example: Password Sync Group 1 - passwordPolicyId: - type: string - description: ID of the password policy - example: 2c91808d744ba0ce01746f93b6204501 - sourceIds: - type: array - description: List of password managed sources IDs - items: - type: string - example: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - created: - type: string - description: The date and time this sync group was created - format: date-time - example: '2023-03-16T04:00:00Z' - nullable: true - modified: - type: string - description: The date and time this sync group was last modified - format: date-time - example: '2023-03-16T04:00:00Z' - nullable: true - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/password-sync-groups#get-password-sync-groups - source: | - $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) - - # Get Password Sync Group List - - try { - Get-PasswordSyncGroups - - # Below is a request that includes all optional parameters - # Get-PasswordSyncGroups -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordSyncGroups" - Write-Host $_.ErrorDetails - } - post: - operationId: createPasswordSyncGroup - tags: - - Password Sync Groups - summary: Create Password Sync Group - description: This API creates a password sync group based on the specifications provided. - security: - - userAuth: - - idn:password-sync-group-management:write - x-sailpoint-userLevels: - - ORG_ADMIN - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1password-sync-groups/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/PasswordSyncGroup.yaml - example: - name: Password Sync Group 2 - passwordPolicyId: 2c91808d744ba0ce01746f93b6204501 - sourceIds: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - responses: - '200': - description: Reference to the password sync group. - content: - application/json: - schema: - $ref: '#/paths/~1password-sync-groups/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/PasswordSyncGroup.yaml - example: - id: 6881f631-3bd5-4213-9c75-8e05cc3e35dd - name: Password Sync Group 2 - passwordPolicyId: 2c91808d744ba0ce01746f93b6204501 - sourceIds: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/password-sync-groups#create-password-sync-group - source: | - $PasswordSyncGroup = @" - { - "created" : "2023-03-16T04:00:00Z", - "name" : "Password Sync Group 1", - "modified" : "2023-03-16T04:00:00Z", - "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", - "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", - "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - } - "@ - - # Create Password Sync Group - - try { - $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup - New-PasswordSyncGroup -PasswordSyncGroup $Result - - # Below is a request that includes all optional parameters - # New-PasswordSyncGroup -PasswordSyncGroup $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PasswordSyncGroup" - Write-Host $_.ErrorDetails - } - /password-sync-groups/{id}: - get: - operationId: getPasswordSyncGroup - tags: - - Password Sync Groups - summary: Get Password Sync Group by ID - description: This API returns the sync group for the specified ID. - security: - - userAuth: - - idn:password-sync-group-management:read - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getPasswordSyncGroups - description: The ID of password sync group to retrieve. - example: 6881f631-3bd5-4213-9c75-8e05cc3e35dd - responses: - '200': - description: Reference to the password sync group. - content: - application/json: - schema: - $ref: '#/paths/~1password-sync-groups/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/PasswordSyncGroup.yaml - example: - id: 6881f631-3bd5-4213-9c75-8e05cc3e35dd - name: Password Sync Group 1 - passwordPolicyId: 2c91808d744ba0ce01746f93b6204501 - sourceIds: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/password-sync-groups#get-password-sync-group - source: | - $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to retrieve. - - # Get Password Sync Group by ID - - try { - Get-PasswordSyncGroup -Id $Id - - # Below is a request that includes all optional parameters - # Get-PasswordSyncGroup -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordSyncGroup" - Write-Host $_.ErrorDetails - } - put: - operationId: updatePasswordSyncGroup - tags: - - Password Sync Groups - summary: Update Password Sync Group by ID - description: This API updates the specified password sync group. - security: - - userAuth: - - idn:password-sync-group-management:write - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getPasswordSyncGroups - description: The ID of password sync group to update. - example: 6881f631-3bd5-4213-9c75-8e05cc3e35dd - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1password-sync-groups/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/PasswordSyncGroup.yaml - example: - id: 6881f631-3bd5-4213-9c75-8e05cc3e35dd - name: Password Sync Group 2 - passwordPolicyId: 2c91808d744ba0ce01746f93b6204501 - sourceIds: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - responses: - '200': - description: Reference to the password sync group. - content: - application/json: - schema: - $ref: '#/paths/~1password-sync-groups/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/PasswordSyncGroup.yaml - example: - id: 6881f631-3bd5-4213-9c75-8e05cc3e35dd - name: Password Sync Group 2 - passwordPolicyId: 2c91808d744ba0ce01746f93b6204501 - sourceIds: - - 2c918084660f45d6016617daa9210584 - - 2c918084660f45d6016617daa9210500 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/password-sync-groups#update-password-sync-group - source: | - $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to update. - $PasswordSyncGroup = @" - { - "created" : "2023-03-16T04:00:00Z", - "name" : "Password Sync Group 1", - "modified" : "2023-03-16T04:00:00Z", - "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", - "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", - "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] - } - "@ - - # Update Password Sync Group by ID - - try { - $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup - Update-PasswordSyncGroup -Id $Id -PasswordSyncGroup $Result - - # Below is a request that includes all optional parameters - # Update-PasswordSyncGroup -Id $Id -PasswordSyncGroup $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-PasswordSyncGroup" - Write-Host $_.ErrorDetails - } - delete: - operationId: deletePasswordSyncGroup - tags: - - Password Sync Groups - summary: Delete Password Sync Group by ID - description: This API deletes the specified password sync group. - security: - - userAuth: - - idn:password-sync-group-management:write - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: getPasswordSyncGroups - description: The ID of password sync group to delete. - example: 6881f631-3bd5-4213-9c75-8e05cc3e35dd - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/password-sync-groups#delete-password-sync-group - source: | - $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to delete. - - # Delete Password Sync Group by ID - - try { - Remove-PasswordSyncGroup -Id $Id - - # Below is a request that includes all optional parameters - # Remove-PasswordSyncGroup -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-PasswordSyncGroup" - Write-Host $_.ErrorDetails - } - /password-policies/{id}: - get: - operationId: getPasswordPolicyById - tags: - - Password Policies - summary: Get Password Policy by ID - description: This API returns the password policy for the specified ID. - security: - - userAuth: - - idn:password-policy:read - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listPasswordPolicies - description: The ID of password policy to retrieve. - example: ff808081838d9e9d01838da6a03e0005 - responses: - '200': - description: Reference to the password policy. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: The password policy Id. - example: 2c91808e7d976f3b017d9f5ceae440c8 - description: - type: string - nullable: true - description: Description for current password policy. - example: Information about the Password Policy - name: - type: string - description: The name of the password policy. - example: PasswordPolicy Example - dateCreated: - type: string - format: date-time - description: Date the Password Policy was created. - example: 1639056206564 - lastUpdated: - type: string - nullable: true - format: date-time - description: Date the Password Policy was updated. - example: 1939056206564 - firstExpirationReminder: - type: integer - format: int64 - description: The number of days before expiration remaninder. - example: 45 - accountIdMinWordLength: - type: integer - format: int64 - description: The minimun length of account Id. By default is equals to -1. - example: 4 - accountNameMinWordLength: - type: integer - format: int64 - description: The minimun length of account name. By default is equals to -1. - example: 6 - minAlpha: - type: integer - format: int64 - description: Maximum alpha. By default is equals to 0. - example: 5 - minCharacterTypes: - type: integer - format: int64 - description: MinCharacterTypes. By default is equals to -1. - example: 5 - maxLength: - type: integer - format: int64 - description: Maximum length of the password. - example: 25 - minLength: - type: integer - format: int64 - description: Minimum length of the password. By default is equals to 0. - example: 8 - maxRepeatedChars: - type: integer - format: int64 - description: Maximum repetition of the same character in the password. By default is equals to -1. - example: 3 - minLower: - type: integer - format: int64 - description: Minimum amount of lower case character in the password. By default is equals to 0. - example: 8 - minNumeric: - type: integer - format: int64 - description: Minimum amount of numeric characters in the password. By default is equals to 0. - example: 8 - minSpecial: - type: integer - format: int64 - description: Minimum amount of special symbols in the password. By default is equals to 0. - example: 8 - minUpper: - type: integer - format: int64 - description: Minimum amount of upper case symbols in the password. By default is equals to 0. - example: 8 - passwordExpiration: - type: integer - format: int64 - description: Number of days before current password expires. By default is equals to 90. - example: 8 - defaultPolicy: - type: boolean - description: Defines whether this policy is default or not. Default policy is created automatically when an org is setup. This field is false by default. - example: true - default: false - enablePasswdExpiration: - type: boolean - description: Defines whether this policy is enabled to expire or not. This field is false by default. - example: true - default: false - requireStrongAuthn: - type: boolean - description: Defines whether this policy require strong Auth or not. This field is false by default. - example: true - default: false - requireStrongAuthOffNetwork: - type: boolean - description: Defines whether this policy require strong Auth of network or not. This field is false by default. - example: true - default: false - requireStrongAuthUntrustedGeographies: - type: boolean - description: Defines whether this policy require strong Auth for untrusted geographies. This field is false by default. - example: true - default: false - useAccountAttributes: - type: boolean - description: Defines whether this policy uses account attributes or not. This field is false by default. - example: false - default: false - useDictionary: - type: boolean - description: Defines whether this policy uses dictionary or not. This field is false by default. - example: false - default: false - useIdentityAttributes: - type: boolean - description: Defines whether this policy uses identity attributes or not. This field is false by default. - example: false - default: false - validateAgainstAccountId: - type: boolean - description: Defines whether this policy validate against account id or not. This field is false by default. - example: false - default: false - validateAgainstAccountName: - type: boolean - description: Defines whether this policy validate against account name or not. This field is false by default. - example: true - default: false - created: - type: string - nullable: true - modified: - type: string - nullable: true - sourceIds: - type: array - description: List of sources IDs managed by this password policy. - items: - type: string - example: - - 2c91808382ffee0b01830de154f14034 - - 2f98808382ffee0b01830de154f12134 - example: - description: Default Password Policy - id: 2c91808e7d976f3b017d9f5ceae440c8 - name: Example PP - dateCreated: 1639056206564 - lastUpdated: 1662385430753 - firstExpirationReminder: 90 - accountIdMinWordLength: 3 - accountNameMinWordLength: 3 - maxLength: 0 - maxRepeatedChars: 4 - minAlpha: 1 - minCharacterTypes: -1 - minLength: 8 - minLower: 0 - minNumeric: 1 - minSpecial: 0 - minUpper: 0 - passwordExpiration: 90 - defaultPolicy: true - enablePasswdExpiration: false - requireStrongAuthn: false - requireStrongAuthOffNetwork: false - requireStrongAuthUntrustedGeographies: false - useAccountAttributes: false - useDictionary: false - useIdentityAttributes: false - validateAgainstAccountId: true - validateAgainstAccountName: true - sourceIds: - - 2c91808382ffee0b01830de154f14034 - - 2c91808582ffee0c01830de36511405f - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/password-policies#get-password-policy-by-id - source: | - $Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve. - - # Get Password Policy by ID - - try { - Get-PasswordPolicyById -Id $Id - - # Below is a request that includes all optional parameters - # Get-PasswordPolicyById -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordPolicyById" - Write-Host $_.ErrorDetails - } - put: - operationId: setPasswordPolicy - tags: - - Password Policies - summary: Update Password Policy by ID - description: This API updates the specified password policy. - security: - - userAuth: - - idn:password-policy:write - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listPasswordPolicies - description: The ID of password policy to update. - example: ff808081838d9e9d01838da6a03e0007 - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1password-policies~1%7Bid%7D/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/PasswordPolicyV3Dto.yaml - example: - description: Password Policy after update. - id: 2c91808e7d976f3b017d9f5ceae440c8 - name: Improved Password Policy - dateCreated: 1639056206564 - lastUpdated: 1662385430753 - firstExpirationReminder: 90 - accountIdMinWordLength: 3 - accountNameMinWordLength: 3 - maxLength: 0 - maxRepeatedChars: 4 - minAlpha: 1 - minCharacterTypes: -1 - minLength: 8 - minLower: 0 - minNumeric: 1 - minSpecial: 0 - minUpper: 0 - passwordExpiration: 90 - defaultPolicy: false - enablePasswdExpiration: false - requireStrongAuthn: false - requireStrongAuthOffNetwork: false - requireStrongAuthUntrustedGeographies: false - useAccountAttributes: false - useDictionary: false - useIdentityAttributes: false - validateAgainstAccountId: true - validateAgainstAccountName: true - sourceIds: - - 2c91808382ffee0b01830de154f14034 - - 2c91808582ffee0c01830de36511405f - responses: - '200': - description: Reference to the password policy. - content: - application/json: - schema: - $ref: '#/paths/~1password-policies~1%7Bid%7D/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/PasswordPolicyV3Dto.yaml - example: - description: Password Policy after update. - id: 2c91808e7d976f3b017d9f5ceae440c8 - name: Improved Password Policy - dateCreated: 1639056206564 - lastUpdated: 1662385430753 - firstExpirationReminder: 90 - accountIdMinWordLength: 3 - accountNameMinWordLength: 3 - maxLength: 0 - maxRepeatedChars: 4 - minAlpha: 1 - minCharacterTypes: -1 - minLength: 8 - minLower: 0 - minNumeric: 1 - minSpecial: 0 - minUpper: 0 - passwordExpiration: 90 - defaultPolicy: false - enablePasswdExpiration: false - requireStrongAuthn: false - requireStrongAuthOffNetwork: false - requireStrongAuthUntrustedGeographies: false - useAccountAttributes: false - useDictionary: false - useIdentityAttributes: false - validateAgainstAccountId: true - validateAgainstAccountName: true - sourceIds: - - 2c91808382ffee0b01830de154f14034 - - 2c91808582ffee0c01830de36511405f - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/password-policies#set-password-policy - source: | - $Id = "ff808081838d9e9d01838da6a03e0007" # String | The ID of password policy to update. - $PasswordPolicyV3Dto = @" - { - "validateAgainstAccountName" : true, - "minLength" : 8, - "description" : "Information about the Password Policy", - "requireStrongAuthUntrustedGeographies" : true, - "enablePasswdExpiration" : true, - "minNumeric" : 8, - "lastUpdated" : "2000-01-23T04:56:07.000+00:00", - "validateAgainstAccountId" : false, - "dateCreated" : "2000-01-23T04:56:07.000+00:00", - "accountNameMinWordLength" : 6, - "minUpper" : 8, - "firstExpirationReminder" : 45, - "modified" : "modified", - "id" : "2c91808e7d976f3b017d9f5ceae440c8", - "requireStrongAuthn" : true, - "useDictionary" : false, - "minSpecial" : 8, - "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], - "passwordExpiration" : 8, - "maxRepeatedChars" : 3, - "minCharacterTypes" : 5, - "minAlpha" : 5, - "created" : "created", - "useAccountAttributes" : false, - "accountIdMinWordLength" : 4, - "minLower" : 8, - "useIdentityAttributes" : false, - "defaultPolicy" : true, - "requireStrongAuthOffNetwork" : true, - "name" : "PasswordPolicy Example", - "maxLength" : 25 - } - "@ - - # Update Password Policy by ID - - try { - $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto - Set-PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result - - # Below is a request that includes all optional parameters - # Set-PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-PasswordPolicy" - Write-Host $_.ErrorDetails - } - delete: - operationId: deletePasswordPolicy - tags: - - Password Policies - summary: Delete Password Policy by ID - description: This API deletes the specified password policy. - security: - - userAuth: - - idn:password-policy:write - x-sailpoint-userLevels: - - ORG_ADMIN - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listPasswordPolicies - description: The ID of password policy to delete. - example: ff808081838d9e9d01838da6a03e0002 - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/password-policies#delete-password-policy - source: | - $Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete. - - # Delete Password Policy by ID - - try { - Remove-PasswordPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Remove-PasswordPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-PasswordPolicy" - Write-Host $_.ErrorDetails - } - /password-policies: - post: - operationId: createPasswordPolicy - tags: - - Password Policies - summary: Create Password Policy - description: This API creates the specified password policy. - security: - - userAuth: - - idn:password-policy:write - x-sailpoint-userLevels: - - ORG_ADMIN - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1password-policies~1%7Bid%7D/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/PasswordPolicyV3Dto.yaml - example: - description: New Password Policy with high requirements to password complexity. - id: null - name: High security Password Policy - dateCreated: 1639056206564 - lastUpdated: 1662385430753 - firstExpirationReminder: 90 - accountIdMinWordLength: 3 - accountNameMinWordLength: 3 - maxLength: 0 - maxRepeatedChars: 4 - minAlpha: 1 - minCharacterTypes: -1 - minLength: 8 - minLower: 0 - minNumeric: 1 - minSpecial: 0 - minUpper: 0 - passwordExpiration: 90 - defaultPolicy: false - enablePasswdExpiration: false - requireStrongAuthn: false - requireStrongAuthOffNetwork: false - requireStrongAuthUntrustedGeographies: false - useAccountAttributes: false - useDictionary: false - useIdentityAttributes: false - validateAgainstAccountId: true - validateAgainstAccountName: true - sourceIds: - - 2c91808382ffee0b01830de154f14034 - - 2c91808582ffee0c01830de36511405f - responses: - '200': - description: Reference to the password policy. - content: - application/json: - schema: - $ref: '#/paths/~1password-policies~1%7Bid%7D/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/PasswordPolicyV3Dto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/password-policies#create-password-policy - source: | - $PasswordPolicyV3Dto = @" - { - "validateAgainstAccountName" : true, - "minLength" : 8, - "description" : "Information about the Password Policy", - "requireStrongAuthUntrustedGeographies" : true, - "enablePasswdExpiration" : true, - "minNumeric" : 8, - "lastUpdated" : "2000-01-23T04:56:07.000+00:00", - "validateAgainstAccountId" : false, - "dateCreated" : "2000-01-23T04:56:07.000+00:00", - "accountNameMinWordLength" : 6, - "minUpper" : 8, - "firstExpirationReminder" : 45, - "modified" : "modified", - "id" : "2c91808e7d976f3b017d9f5ceae440c8", - "requireStrongAuthn" : true, - "useDictionary" : false, - "minSpecial" : 8, - "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], - "passwordExpiration" : 8, - "maxRepeatedChars" : 3, - "minCharacterTypes" : 5, - "minAlpha" : 5, - "created" : "created", - "useAccountAttributes" : false, - "accountIdMinWordLength" : 4, - "minLower" : 8, - "useIdentityAttributes" : false, - "defaultPolicy" : true, - "requireStrongAuthOffNetwork" : true, - "name" : "PasswordPolicy Example", - "maxLength" : 25 - } - "@ - - # Create Password Policy - - try { - $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto - New-PasswordPolicy -PasswordPolicyV3Dto $Result - - # Below is a request that includes all optional parameters - # New-PasswordPolicy -PasswordPolicyV3Dto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PasswordPolicy" - Write-Host $_.ErrorDetails - } - get: - operationId: listPasswordPolicies - tags: - - Password Policies - summary: List Password Policies - description: |- - This gets list of all Password Policies. - Requires role of ORG_ADMIN - security: - - userAuth: - - idn:password-policy:read - parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml - responses: - '200': - description: List of all Password Policies. - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1password-policies~1%7Bid%7D/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/PasswordPolicyV3Dto.yaml - example: - - description: Example Password Policy - id: 2c91808e7d976f3b017d9f5ceae440c8 - name: Example PP - dateCreated: 1639056206564 - lastUpdated: 1662385430753 - firstExpirationReminder: 90 - accountIdMinWordLength: 3 - accountNameMinWordLength: 3 - maxLength: 0 - maxRepeatedChars: 4 - minAlpha: 1 - minCharacterTypes: -1 - minLength: 8 - minLower: 0 - minNumeric: 1 - minSpecial: 0 - minUpper: 0 - passwordExpiration: 90 - defaultPolicy: false - enablePasswdExpiration: false - requireStrongAuthn: false - requireStrongAuthOffNetwork: false - requireStrongAuthUntrustedGeographies: false - useAccountAttributes: false - useDictionary: false - useIdentityAttributes: false - validateAgainstAccountId: true - validateAgainstAccountName: true - sourceIds: - - 2c91808382ffee0b01830de154f14034 - - 2c91808582ffee0c01830de36511405f - - description: null - id: 2c91808780b8b8430180ff7a093f3bf2 - name: Password Policy 1 test - dateCreated: 1653553629503 - lastUpdated: null - firstExpirationReminder: null - accountIdMinWordLength: -1 - accountNameMinWordLength: -1 - maxLength: 0 - maxRepeatedChars: -1 - minAlpha: 1 - minCharacterTypes: -1 - minLength: 8 - minLower: 0 - minNumeric: 1 - minSpecial: 0 - minUpper: 0 - passwordExpiration: 90 - defaultPolicy: false - enablePasswdExpiration: false - requireStrongAuthn: false - requireStrongAuthOffNetwork: false - requireStrongAuthUntrustedGeographies: false - useAccountAttributes: false - useDictionary: false - useIdentityAttributes: true - validateAgainstAccountId: false - validateAgainstAccountName: false - sourceIds: [] - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/password-policies#list-password-policies - source: | - $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 Password Policies - - try { - Get-PasswordPolicies - - # Below is a request that includes all optional parameters - # Get-PasswordPolicies -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordPolicies" - Write-Host $_.ErrorDetails - } - /personal-access-tokens: - get: - operationId: listPersonalAccessTokens - security: - - userAuth: - - sp:my-personal-access-tokens:read - - sp:my-personal-access-tokens:manage - - sp:all-personal-access-tokens:read - - sp:all-personal-access-tokens:manage - tags: - - Personal Access Tokens - summary: List Personal Access Tokens - description: This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right. - parameters: - - in: query - name: owner-id - description: |- - The identity ID of the owner whose personal access tokens should be listed. If "me", the caller should have the following right: 'idn:my-personal-access-tokens:read' - If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. - If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' - required: false - schema: - type: string - default: null - example: 2c9180867b50d088017b554662fb281e - - in: query - name: filters - required: false - schema: - type: string - description: |- - 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: - - **lastUsed**: *le, isnull* - example: lastUsed le 2023-02-05T10:59:27.214Z - responses: - '200': - description: List of personal access tokens. - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: The ID of the personal access token (to be used as the username for Basic Auth). - example: 86f1dc6fe8f54414950454cbb11278fa - name: - type: string - description: The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. - example: NodeJS Integration - scope: - type: array - nullable: true - items: - type: string - default: sp:scopes:all - description: Scopes of the personal access token. - example: - - demo:personal-access-token-scope:first - - demo:personal-access-token-scope:second - owner: - type: object - description: Personal access token owner's identity. - properties: - type: - type: string - description: Personal access token owner's DTO type. - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: Personal access token owner's identity ID. - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - description: Personal access token owner's human-readable display name. - example: Support - created: - type: string - format: date-time - description: The date and time, down to the millisecond, when this personal access token was created. - example: '2017-07-11T18:45:37.098Z' - lastUsed: - type: string - nullable: true - format: date-time - description: The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed. - example: '2017-07-11T18:45:37.098Z' - managed: - type: boolean - default: false - example: false - description: If true, this token is managed by the SailPoint platform, and is not visible in the user interface. For example, Workflows will create managed personal access tokens for users who create workflows. - required: - - id - - name - - scope - - owner - - created - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/personal-access-tokens#list-personal-access-tokens - source: | - $OwnerId = "2c9180867b50d088017b554662fb281e" # String | The identity ID of the owner whose personal access tokens should be listed. If ""me"", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) - $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # 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: **lastUsed**: *le, isnull* (optional) - - # List Personal Access Tokens - - try { - Get-PersonalAccessTokens - - # Below is a request that includes all optional parameters - # Get-PersonalAccessTokens -OwnerId $OwnerId -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PersonalAccessTokens" - Write-Host $_.ErrorDetails - } - post: - operationId: createPersonalAccessToken - security: - - userAuth: - - sp:my-personal-access-tokens:manage - - sp:all-personal-access-tokens:manage - tags: - - Personal Access Tokens - summary: Create Personal Access Token - description: This creates a personal access token. - requestBody: - description: Name and scope of personal access token. - required: true - content: - application/json: - schema: - type: object - description: Object for specifying the name of a personal access token to create - properties: - name: - type: string - description: The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created. - example: NodeJS Integration - scope: - type: array - nullable: true - items: - type: string - default: sp:scopes:all - description: Scopes of the personal access token. If no scope is specified, the token will be created with the default scope "sp:scopes:all". This means the personal access token will have all the rights of the owner who created it. - example: - - demo:personal-access-token-scope:first - - demo:personal-access-token-scope:second - accessTokenValiditySeconds: - type: integer - format: int32 - minimum: 15 - maximum: 43200 - items: - type: integer - format: int32 - default: 43200 - description: Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. - example: 36900 - required: - - name - responses: - '200': - description: Created. Note - this is the only time Personal Access Tokens' secret attribute will be displayed. - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: The ID of the personal access token (to be used as the username for Basic Auth). - example: 86f1dc6fe8f54414950454cbb11278fa - secret: - type: string - description: The secret of the personal access token (to be used as the password for Basic Auth). - example: 1d1bef2b9f426383447f64f69349fc7cac176042578d205c256ba3f37c59adb9 - scope: - type: array - nullable: true - items: - type: string - default: sp:scopes:all - description: Scopes of the personal access token. - example: - - demo:personal-access-token-scope:first - - demo:personal-access-token-scope:second - name: - type: string - description: The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. - example: NodeJS Integration - owner: - $ref: '#/paths/~1personal-access-tokens/get/responses/200/content/application~1json/schema/items/properties/owner' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/PatOwner.yaml - created: - type: string - format: date-time - description: The date and time, down to the millisecond, when this personal access token was created. - example: '2017-07-11T18:45:37.098Z' - accessTokenValiditySeconds: - type: integer - format: int32 - items: - type: integer - format: int32 - default: 43200 - description: Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. - example: 36900 - required: - - id - - secret - - scope - - name - - owner - - created - - accessTokenValiditySeconds - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/personal-access-tokens#create-personal-access-token - source: | - $CreatePersonalAccessTokenRequest = @" - { - "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], - "accessTokenValiditySeconds" : 36900, - "name" : "NodeJS Integration" - } - "@ - - # Create Personal Access Token - - try { - $Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest - New-PersonalAccessToken -CreatePersonalAccessTokenRequest $Result - - # Below is a request that includes all optional parameters - # New-PersonalAccessToken -CreatePersonalAccessTokenRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PersonalAccessToken" - Write-Host $_.ErrorDetails - } - /personal-access-tokens/{id}: - patch: - operationId: patchPersonalAccessToken - security: - - userAuth: - - sp:my-personal-access-tokens:manage - tags: - - Personal Access Tokens - summary: Patch Personal Access Token - description: |- - This performs a targeted update to the field(s) of a Personal Access Token. - Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listPersonalAccessTokens - description: The Personal Access Token id - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - description: | - A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - The following fields are patchable: - * name - * scope - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml - example: - - op: replace - path: /name - value: New name - - op: replace - path: /scope - value: - - sp:scopes:all - responses: - '200': - description: Indicates the PATCH operation succeeded, and returns the PAT's new representation. - content: - application/json: - schema: - $ref: '#/paths/~1personal-access-tokens/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/GetPersonalAccessTokenResponse.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/personal-access-tokens#patch-personal-access-token - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The Personal Access Token id - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Personal Access Token - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-PersonalAccessToken -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-PersonalAccessToken -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-PersonalAccessToken" - Write-Host $_.ErrorDetails - } - delete: - operationId: deletePersonalAccessToken - security: - - userAuth: - - sp:my-personal-access-tokens:manage - - sp:all-personal-access-tokens:manage - tags: - - Personal Access Tokens - summary: Delete Personal Access Token - description: This deletes a personal access token. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listPersonalAccessTokens - description: The personal access token id - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '204': - description: No content. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/personal-access-tokens#delete-personal-access-token - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id - - # Delete Personal Access Token - - try { - Remove-PersonalAccessToken -Id $Id - - # Below is a request that includes all optional parameters - # Remove-PersonalAccessToken -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-PersonalAccessToken" - Write-Host $_.ErrorDetails - } - /public-identities: - get: - operationId: getPublicIdentities - tags: - - Public Identities - summary: Get list of public identities - description: Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts. - security: - - userAuth: - - sp:scopes:default - x-sailpoint-userLevels: - - USER - parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml - - in: query - name: filters - schema: - type: string - required: false - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **alias**: *eq, sw* - - **email**: *eq, sw* - - **firstname**: *eq, sw* - - **lastname**: *eq, sw* - example: firstname eq "John" - - in: query - name: add-core-filters - description: |- - If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - - Should be either correlated or protected. - - Should not be "spadmin" or "cloudadmin". - - uid should not be null. - - lastname should not be null. - - email should not be null. - required: false - example: false - schema: - type: boolean - default: false - - in: query - name: sorters - schema: - type: string - format: comma-separated - required: false - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name** - example: name - responses: - '200': - description: A list of public identity objects. - content: - application/json: - schema: - type: array - items: - type: object - title: Public Identity - description: Details about a public identity - properties: - id: - type: string - description: Identity id - example: 2c9180857182305e0171993735622948 - name: - type: string - description: Human-readable display name of identity. - example: Alison Ferguso - alias: - type: string - description: Alternate unique identifier for the identity. - example: alison.ferguso - email: - nullable: true - type: string - description: Email address of identity. - example: alison.ferguso@acme-solar.com - status: - nullable: true - type: string - description: The lifecycle status for the identity - example: Active - identityState: - nullable: true - type: string - enum: - - ACTIVE - - INACTIVE_SHORT_TERM - - INACTIVE_LONG_TERM - - null - example: ACTIVE - description: | - The current state of the identity, which determines how Identity Security Cloud interacts with the identity. - An identity that is Active will be included identity picklists in Request Center, identity processing, and more. - Identities that are Inactive will be excluded from these features. - manager: - type: object - nullable: true - description: The manager for the identity. - properties: - type: - $ref: '#/components/schemas/Account/allOf/1/properties/ownerIdentity/allOf/0/properties/type' - example: IDENTITY - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/DtoType.yaml - id: - type: string - description: Identity id - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - description: Human-readable display name of identity. - example: Thomas Edison - attributes: - type: array - description: The public identity attributes of the identity - items: - type: object - properties: - key: - type: string - description: The attribute key - example: country - name: - type: string - description: Human-readable display name of the attribute - example: Country - value: - type: string - description: The attribute value - example: US - nullable: true - example: - - id: 2c9180857182305e0171993735622948 - name: Alison Ferguso - alias: alison.ferguso - email: alison.ferguso@acme-solar.com - status: Active - manager: - type: IDENTITY - id: 2c9180a46faadee4016fb4e018c20639 - name: Thomas Edison - attributes: - - key: phone - name: Phone - value: '5125551234' - - key: country - name: Country - value: US - - id: 2c9180a46faadee4016fb4e018c20639 - name: Thomas Edison - alias: thomas.edison - email: thomas.edison@acme-solar.com - status: Active - manager: - type: IDENTITY - id: 2c918086676d3e0601677611dbde220f - name: Mister Manager - attributes: - - key: phone - name: Phone - value: '5125554321' - - key: country - name: Country - value: US - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/public-identities#get-public-identities - source: | - $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) - $Filters = "firstname eq "John"" # 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: **id**: *eq, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (optional) - $AddCoreFilters = $false # Boolean | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be ""spadmin"" or ""cloudadmin"". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to $false) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - - # Get list of public identities - - try { - Get-PublicIdentities - - # Below is a request that includes all optional parameters - # Get-PublicIdentities -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -AddCoreFilters $AddCoreFilters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PublicIdentities" - Write-Host $_.ErrorDetails - } - /public-identities-config: - get: - operationId: getPublicIdentityConfig - tags: - - Public Identities Config - summary: Get the Public Identities Configuration - description: Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. - security: - - userAuth: [] - x-sailpoint-userLevels: - - ORG_ADMIN - responses: - '200': - description: Request succeeded. - content: - application/json: - schema: - type: object - description: Details of up to 5 Identity attributes that will be publicly accessible for all Identities to anyone in the org. - properties: - attributes: - type: array - description: Up to 5 identity attributes that will be available to everyone in the org for all users in the org. - items: - type: object - description: Used to map an attribute key for an Identity to its display name. - properties: - key: - type: string - description: The attribute key - example: country - name: - type: string - description: The attribute display name - example: Country - modified: - nullable: true - type: string - description: When this configuration was last modified. - format: date-time - example: '2018-06-25T20:22:28.104Z' - modifiedBy: - $ref: '#/paths/~1public-identities/get/responses/200/content/application~1json/schema/items/properties/manager' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentityReference.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/public-identities-config#get-public-identity-config - source: | - - # Get the Public Identities Configuration - - try { - Get-PublicIdentityConfig - - # Below is a request that includes all optional parameters - # Get-PublicIdentityConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PublicIdentityConfig" - Write-Host $_.ErrorDetails - } - put: - operationId: updatePublicIdentityConfig - tags: - - Public Identities Config - summary: Update the Public Identities Configuration - description: Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. - security: - - userAuth: [] - x-sailpoint-userLevels: - - ORG_ADMIN - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1public-identities-config/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/PublicIdentityConfig.yaml - responses: - '200': - description: Request succeeded. - content: - application/json: - schema: - $ref: '#/paths/~1public-identities-config/get/responses/200/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/PublicIdentityConfig.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/public-identities-config#update-public-identity-config - source: | - $PublicIdentityConfig = @" - { - "modified" : "2018-06-25T20:22:28.104Z", - "attributes" : [ { - "name" : "Country", - "key" : "country" - }, { - "name" : "Country", - "key" : "country" - } ], - "modifiedBy" : { - "name" : "Thomas Edison", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - } - "@ - - # Update the Public Identities Configuration - - try { - $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig - Update-PublicIdentityConfig -PublicIdentityConfig $Result - - # Below is a request that includes all optional parameters - # Update-PublicIdentityConfig -PublicIdentityConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-PublicIdentityConfig" - Write-Host $_.ErrorDetails - } - /requestable-objects: - get: - operationId: listRequestableObjects - tags: - - Requestable Objects - summary: Requestable Objects List - security: - - userAuth: [] - x-sailpoint-userLevels: - - ORG_ADMIN - description: |- - This endpoint returns a list of acccess items that that can be requested through the Access Request endpoints. Access items are marked with AVAILABLE, PENDING or ASSIGNED with respect to the identity provided using *identity-id* query param. - Any authenticated token can call this endpoint to see their requestable access items. - parameters: - - in: query - name: identity-id - required: false - schema: - type: string - example: e7eab60924f64aa284175b9fa3309599 - description: |- - If present, the value returns only requestable objects for the specified identity. - * Admin users can call this with any identity ID value. - * Non-admin users can only specify *me* or pass their own identity ID value. - * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. - - in: query - name: types - description: Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice. - required: false - schema: - type: array - items: - $ref: '#/components/schemas/RequestableObject/properties/type' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/RequestableObjectType.yaml - example: ROLE,ACCESS_PROFILE - explode: false - - in: query - name: term - required: false - schema: - type: string - example: Finance Role - description: It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored. - - in: query - name: statuses - description: Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. - required: false - schema: - type: array - items: - $ref: '#/components/schemas/RequestableObject/properties/requestStatus/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/RequestableObjectRequestStatus.yaml - explode: false - example: - - ASSIGNED - - PENDING - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml - - in: query - name: filters - schema: - type: string - example: name sw "bob" - description: | - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **name**: *eq, in, sw* - required: false - - in: query - name: sorters - schema: - type: string - format: comma-separated - required: false - example: name - description: | - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name** - responses: - '200': - description: List of requestable objects - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: string - description: Id of the requestable object itself - example: 2c9180835d2e5168015d32f890ca1581 - name: - type: string - description: Human-readable display name of the requestable object - example: Applied Research Access - created: - type: string - format: date-time - example: '2017-07-11T18:45:37.098Z' - description: The time when the requestable object was created - modified: - nullable: true - type: string - format: date-time - example: '2018-06-25T20:22:28.104Z' - description: The time when the requestable object was last modified - description: - type: string - description: Description of the requestable object. - example: Access to research information, lab results, and schematics. - nullable: true - type: - $ref: '#/components/schemas/RequestableObject/properties/type' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/RequestableObjectType.yaml - requestStatus: - allOf: - - $ref: '#/components/schemas/RequestableObject/properties/requestStatus/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/RequestableObjectRequestStatus.yaml - - nullable: true - identityRequestId: - type: string - description: If *requestStatus* is *PENDING*, indicates the id of the associated account activity. - nullable: true - example: null - ownerRef: - $ref: '#/components/schemas/RequestableObject/properties/ownerRef' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/IdentityReferenceWithNameAndEmail.yaml - requestCommentsRequired: - type: boolean - description: Whether the requester must provide comments when requesting the object. - example: false - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/requestable-objects#list-requestable-objects - source: | - $IdentityId = "e7eab60924f64aa284175b9fa3309599" # String | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) - $Types = "ACCESS_PROFILE" # RequestableObjectType[] | Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice. (optional) - - $Types = @"ROLE,ACCESS_PROFILE"@ - $Term = "Finance Role" # String | It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored. (optional) - $Statuses = "AVAILABLE" # RequestableObjectRequestStatus[] | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. (optional) - - $Statuses = @"[ASSIGNED, PENDING]"@ - $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) - $Filters = "name sw "bob"" # 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: **id**: *eq, in* **name**: *eq, in, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - - # Requestable Objects List - - try { - Get-RequestableObjects - - # Below is a request that includes all optional parameters - # Get-RequestableObjects -IdentityId $IdentityId -Types $Types -Term $Term -Statuses $Statuses -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-RequestableObjects" - Write-Host $_.ErrorDetails - } - /roles: - get: - operationId: listRoles - tags: - - Roles - summary: List Roles - description: This API returns a list of Roles. - parameters: - - in: query - name: for-subadmin - schema: - type: string - description: If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - example: 5168015d32f890ca15812c9180835d2e - required: false - - $ref: '#/paths/~1access-profiles/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit50.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **name**: *eq, sw* - - **created**: *gt, lt, ge, le* - - **modified**: *gt, lt, ge, le* - - **owner.id**: *eq, in* - - **requestable**: *eq* - example: requestable eq false - required: false - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name, created, modified** - example: name,-modified - required: false - - in: query - name: for-segment-ids - schema: - type: string - format: comma-separated - description: |- - If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. - - If segmentation is currently unavailable, specifying this parameter results in an error. - example: 0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d - required: false - - in: query - name: include-unsegmented - schema: - type: boolean - default: true - description: Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. - example: false - required: false - responses: - '200': - description: List of Roles - content: - application/json: - schema: - type: array - items: - type: object - description: A Role - properties: - id: - type: string - description: The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result. - example: 2c918086749d78830174a1a40e121518 - name: - type: string - description: The human-readable display name of the Role - maxLength: 128 - example: Role 2567 - created: - type: string - description: Date the Role was created - format: date-time - example: '2021-03-01T22:32:58.104Z' - readOnly: true - modified: - type: string - description: Date the Role was last modified. - format: date-time - example: '2021-03-02T20:22:28.104Z' - readOnly: true - description: - type: string - nullable: true - description: A human-readable description of the Role - example: Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor. - owner: - $ref: '#/paths/~1access-profiles/get/responses/200/content/application~1json/schema/items/properties/owner' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/access/OwnerReference.yaml - accessProfiles: - type: array - items: - type: object - properties: - id: - type: string - description: ID of the Access Profile - example: ff808081751e6e129f1518161919ecca - type: - type: string - description: Type of requested object. This field must be either left null or set to 'ACCESS_PROFILE' when creating an Access Profile, otherwise a 400 Bad Request error will result. - enum: - - ACCESS_PROFILE - example: ACCESS_PROFILE - name: - type: string - description: Human-readable display name of the Access Profile. This field is ignored on input. - example: Access Profile 2567 - nullable: true - entitlements: - type: array - items: - $ref: '#/paths/~1access-profiles/get/responses/200/content/application~1json/schema/items/properties/entitlements/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/access/EntitlementRef.yaml - membership: - type: object - nullable: true - description: When present, specifies that the Role is to be granted to Identities which either satisfy specific criteria or which are members of a given list of Identities. - properties: - type: - type: string - enum: - - STANDARD - - IDENTITY_LIST - description: |- - This enum characterizes the type of a Role's membership selector. Only the following two are fully supported: - - STANDARD: Indicates that Role membership is defined in terms of a criteria expression - - IDENTITY_LIST: Indicates that Role membership is conferred on the specific identities listed - example: IDENTITY_LIST - criteria: - type: object - nullable: true - description: Defines STANDARD type Role membership - properties: - operation: - type: string - enum: - - EQUALS - - NOT_EQUALS - - CONTAINS - - STARTS_WITH - - ENDS_WITH - - AND - - OR - description: An operation - example: EQUALS - key: - type: object - nullable: true - description: Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria - properties: - type: - type: string - enum: - - IDENTITY - - ACCOUNT - - ENTITLEMENT - description: Indicates whether the associated criteria represents an expression on identity attributes, account attributes, or entitlements, respectively. - example: ACCOUNT - property: - type: string - description: The name of the attribute or entitlement to which the associated criteria applies. - example: attribute.email - sourceId: - type: string - nullable: true - description: ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT - example: 2c9180867427f3a301745aec18211519 - required: - - type - - property - stringValue: - type: string - nullable: true - description: String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. - example: carlee.cert1c9f9b6fd@mailinator.com - children: - type: array - items: - type: object - nullable: true - description: Defines STANDARD type Role membership - properties: - operation: - $ref: '#/paths/~1roles/get/responses/200/content/application~1json/schema/items/properties/membership/properties/criteria/properties/operation' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/access/RoleCriteriaOperation.yaml - key: - $ref: '#/paths/~1roles/get/responses/200/content/application~1json/schema/items/properties/membership/properties/criteria/properties/key' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/access/RoleCriteriaKey.yaml - stringValue: - type: string - nullable: true - description: String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. - example: carlee.cert1c9f9b6fd@mailinator.com - children: - type: array - items: - type: object - description: Defines STANDARD type Role membership - properties: - operation: - $ref: '#/paths/~1roles/get/responses/200/content/application~1json/schema/items/properties/membership/properties/criteria/properties/operation' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/access/RoleCriteriaOperation.yaml - key: - $ref: '#/paths/~1roles/get/responses/200/content/application~1json/schema/items/properties/membership/properties/criteria/properties/key' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/access/RoleCriteriaKey.yaml - stringValue: - type: string - description: String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. - example: carlee.cert1c9f9b6fd@mailinator.com - nullable: true - description: Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. - nullable: true - description: Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. - identities: - type: array - items: - type: object - description: A reference to an Identity in an IDENTITY_LIST role membership criteria. - properties: - type: - $ref: '#/components/schemas/Account/allOf/1/properties/ownerIdentity/allOf/0/properties/type' - nullable: true - example: IDENTITY - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/DtoType.yaml - id: - type: string - description: Identity id - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - nullable: true - description: Human-readable display name of the Identity. - example: Thomas Edison - aliasName: - type: string - nullable: true - description: User name of the Identity - example: t.edison - nullable: true - description: Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. - legacyMembershipInfo: - type: object - nullable: true - description: This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration. - example: - type: IDENTITY_LIST - additionalProperties: true - enabled: - type: boolean - description: Whether the Role is enabled or not. - example: true - default: false - requestable: - type: boolean - description: Whether the Role can be the target of access requests. - example: true - default: false - accessRequestConfig: - type: object - properties: - commentsRequired: - type: boolean - description: Whether the requester of the containing object must provide comments justifying the request - example: true - nullable: true - default: false - denialCommentsRequired: - type: boolean - description: Whether an approver must provide comments when denying the request - example: true - nullable: true - default: false - approvalSchemes: - type: array - description: List describing the steps in approving the request - items: - type: object - properties: - approverType: - type: string - enum: - - OWNER - - MANAGER - - GOVERNANCE_GROUP - description: |- - Describes the individual or group that is responsible for an approval step. Values are as follows. - - **OWNER**: Owner of the associated Role - - **MANAGER**: Manager of the Identity making the request - - **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field - example: GOVERNANCE_GROUP - approverId: - type: string - nullable: true - description: Id of the specific approver, used only when approverType is GOVERNANCE_GROUP - example: 46c79819-a69f-49a2-becb-12c971ae66c6 - revocationRequestConfig: - type: object - properties: - commentsRequired: - type: boolean - description: Whether the requester of the containing object must provide comments justifying the request - example: false - nullable: true - default: false - denialCommentsRequired: - type: boolean - description: Whether an approver must provide comments when denying the request - example: false - nullable: true - default: false - approvalSchemes: - type: array - description: List describing the steps in approving the revocation request - items: - $ref: '#/paths/~1roles/get/responses/200/content/application~1json/schema/items/properties/accessRequestConfig/properties/approvalSchemes/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/access/ApprovalSchemeForRole.yaml - segments: - type: array - items: - type: string - nullable: true - description: List of IDs of segments, if any, to which this Role is assigned. - example: - - f7b1b8a3-5fed-4fd4-ad29-82014e137e19 - - 29cb6c06-1da8-43ea-8be4-b3125f248f2a - dimensional: - description: Whether the Role is dimensional. - type: boolean - nullable: true - default: false - dimensionRefs: - type: array - items: - type: object - properties: - type: - type: string - enum: - - DIMENSION - description: The type of the object to which this reference applies - example: DIMENSION - id: - type: string - description: ID of the object to which this reference applies - example: 2c91808568c529c60168cca6f90c1313 - name: - type: string - description: Human-readable display name of the object to which this reference applies - example: Role 2 - nullable: true - description: List of references to dimensions to which this Role is assigned. This field is only relevant if the Role is dimensional. - accessModelMetadata: - type: object - properties: - attributes: - type: array - nullable: true - items: - type: object - properties: - key: - type: string - description: Technical name of the Attribute. This is unique and cannot be changed after creation. - example: iscPrivacy - name: - type: string - description: The display name of the key. - example: Privacy - multiselect: - type: boolean - default: false - description: Indicates whether the attribute can have multiple values. - example: false - status: - type: string - description: The status of the Attribute. - example: active - type: - type: string - description: The type of the Attribute. This can be either "custom" or "governance". - example: governance - objectTypes: - type: array - items: - type: string - nullable: true - description: An array of object types this attributes values can be applied to. Possible values are "all" or "entitlement". Value "all" means this attribute can be used with all object types that are supported. - example: - - entitlement - description: - type: string - description: The description of the Attribute. - example: Specifies the level of privacy associated with an access item. - values: - type: array - nullable: true - items: - type: object - properties: - value: - type: string - description: Technical name of the Attribute value. This is unique and cannot be changed after creation. - example: public - name: - type: string - description: The display name of the Attribute value. - example: Public - status: - type: string - description: The status of the Attribute value. - example: active - example: - - key: iscPrivacy - name: Privacy - multiselect: false - status: active - type: governance - objectTypes: - - all - description: Specifies the level of privacy associated with an access item. - values: - - value: public - name: Public - status: active - required: - - name - - owner - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:role-unchecked:read - - idn:role-unchecked:manage - - idn:role-checked:manage - - idn:role-checked:read - x-sailpoint-userLevels: - - ORG_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/roles#list-roles - source: | - $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) - $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) - $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) - $Filters = "requestable eq false" # 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: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) - $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) - $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) - - # List Roles - - try { - Get-Roles - - # Below is a request that includes all optional parameters - # Get-Roles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Roles" - Write-Host $_.ErrorDetails - } - post: - operationId: createRole - tags: - - Roles - summary: Create a Role - description: |- - This API creates a role. - In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. - - The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/paths/~1roles/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/access/Role.yaml - responses: - '201': - description: Role created - content: - application/json: - schema: - $ref: '#/paths/~1roles/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/access/Role.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:role-unchecked:manage - - idn:role-checked:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/roles#create-role - source: | - $Role = @" - { - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "entitlements" : [ { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - }, { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - } ], - "dimensional" : false, - "created" : "2021-03-01T22:32:58.104Z", - "dimensionRefs" : [ { - "name" : "Role 2", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "DIMENSION" - }, { - "name" : "Role 2", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "DIMENSION" - } ], - "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", - "membership" : { - "identities" : [ { - "aliasName" : "t.edison", - "name" : "Thomas Edison", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, { - "aliasName" : "t.edison", - "name" : "Thomas Edison", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } ], - "criteria" : { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - } ], - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - } ], - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - } ], - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, - "type" : "IDENTITY_LIST" - }, - "enabled" : true, - "revocationRequestConfig" : { - "commentsRequired" : false, - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ], - "denialCommentsRequired" : false - }, - "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], - "legacyMembershipInfo" : { - "type" : "IDENTITY_LIST" - }, - "accessRequestConfig" : { - "commentsRequired" : true, - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ], - "denialCommentsRequired" : true - }, - "accessProfiles" : [ { - "name" : "Access Profile 2567", - "id" : "ff808081751e6e129f1518161919ecca", - "type" : "ACCESS_PROFILE" - }, { - "name" : "Access Profile 2567", - "id" : "ff808081751e6e129f1518161919ecca", - "type" : "ACCESS_PROFILE" - } ], - "name" : "Role 2567", - "modified" : "2021-03-02T20:22:28.104Z", - "accessModelMetadata" : { - "attributes" : [ { - "key" : "iscPrivacy", - "name" : "Privacy", - "multiselect" : false, - "status" : "active", - "type" : "governance", - "objectTypes" : [ "all" ], - "description" : "Specifies the level of privacy associated with an access item.", - "values" : [ { - "value" : "public", - "name" : "Public", - "status" : "active" - } ] - } ] - }, - "id" : "2c918086749d78830174a1a40e121518", - "requestable" : true - } - "@ - - # Create a Role - - try { - $Result = ConvertFrom-JsonToRole -Json $Role - New-Role -Role $Result - - # Below is a request that includes all optional parameters - # New-Role -Role $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Role" - Write-Host $_.ErrorDetails - } - /roles/{id}: - get: - operationId: getRole - tags: - - Roles - summary: Get a Role - description: |- - This API returns a Role by its ID. - A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - parameters: - - in: path - name: id - required: true - x-sailpoint-resource-operation-id: listRoles - schema: - type: string - description: ID of the Role - example: 2c91808a7813090a017814121e121518 - responses: - '200': - description: List of all Roles - content: - application/json: - schema: - $ref: '#/paths/~1roles/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/access/Role.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:role-unchecked:read - - idn:role-unchecked:manage - - idn:role-checked:manage - - idn:role-checked:read - x-sailpoint-userLevels: - - ORG_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/roles#get-role - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role - - # Get a Role - - try { - Get-Role -Id $Id - - # Below is a request that includes all optional parameters - # Get-Role -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Role" - Write-Host $_.ErrorDetails - } - patch: - operationId: patchRole - tags: - - Roles - summary: Patch a specified Role - description: |- - This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. - The following fields are patchable: - * name - * description - * enabled - * owner - * accessProfiles - * entitlements - * membership - * requestable - * accessRequestConfig - * revokeRequestConfig - * segments - * accessModelMetadata - - A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - - The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. - - When you use this API to modify a role's membership identities, you can only modify up to a limit of 500 membership identities at a time. - parameters: - - name: id - in: path - description: ID of the Role to patch - required: true - x-sailpoint-resource-operation-id: listRoles - schema: - type: string - example: 2c91808a7813090a017814121e121518 - requestBody: - content: - application/json-patch+json: - schema: - type: array - items: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/patch/requestBody/content/application~1json-patch%2Bjson/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/JsonPatchOperation.yaml - examples: - Make a Role Requestable and Enable it in One Call: - description: This example shows how multiple fields may be updated with a single patch call. - value: - - op: replace - path: /requestable - value: true - - op: replace - path: /enabled - value: true - Assign a Role to a Segment: - description: This example illustrates the use of patch to assign a Role to a Segment by adding the Segment's ID to the Role's segments array. - value: - - op: add - path: /segments/- - value: f7b1b8a3-5fed-4fd4-ad29-82014e137e19 - Set the Membership Selection Criteria to a List of Identities: - description: This example shows how to define a Role's membershp by providing a list of Identities, referenced by their IDs. - value: - - op: replace - path: /membership - value: - type: IDENTITY_LIST - identities: - - id: 2c91808973fe906c0174262092014ed9 - - id: 2c918086262092014ed94fb8a47612f3 - Set the Membership Selection Criteria to a Standard Expression: - description: This example shows how to define a Role's membership using STANDARD criteria. In this case, the Role will be granted to all Identities which have the *Engineering* attribute from the indicated Source. - value: - - op: replace - path: /membership - value: - type: STANDARD - criteria: - operation: OR - children: - - operation: EQUALS - key: - type: ENTITLEMENT - property: attribute.memberOf - sourceId: 2c9180887701fb2014213e122092014e - stringValue: Engineering - Add a New Clause as the Child of an Existing Standard Expression: - description: This example shows how to add a child clause to an existing STANDARD criteria expression. - value: - - op: add - path: /membership/criteria/children/- - value: - operation: ENDS_WITH - key: - type: IDENTITY - property: attribute.email - stringValue: '@identitynow.com' - Assign a Access Model Metadata to a Role: - description: This example shows how to assign a existing metadata to a role. - value: - - op: add - path: /accessModelMetadata/attributes/0 - value: - key: iscFederalClassifications - values: - - value: secret - Add an Access Profile to a Role: - description: This example shows how to add an access profile to a role. - value: - - op: add - path: /accessProfiles/- - value: - id: 1de104e1f9024b1289b3a31e22d28cd1 - type: ACCESS_PROFILE - Add an Entitlement to a Role: - description: This example shows how to add an entitlement to a role. - value: - - op: add - path: /entitlements/- - value: - id: 0fb2f8051e48421b8f1f8a64aee3b205 - type: ENTITLEMENT - required: true - responses: - '200': - description: Responds with the Role as updated. - content: - application/json: - schema: - $ref: '#/paths/~1roles/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/access/Role.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:role-unchecked:manage - - idn:role-checked:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/roles#patch-role - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch a specified Role - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-Role -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-Role -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Role" - Write-Host $_.ErrorDetails - } - delete: - operationId: deleteRole - tags: - - Roles - summary: Delete a Role - description: |- - This API deletes a Role by its ID. - - A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - parameters: - - in: path - name: id - required: true - x-sailpoint-resource-operation-id: listRoles - schema: - type: string - description: ID of the Role - example: 2c91808a7813090a017814121e121518 - responses: - '204': - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/204' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/204.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:role-unchecked:manage - - idn:role-checked:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/roles#delete-role - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role - - # Delete a Role - - try { - Remove-Role -Id $Id - - # Below is a request that includes all optional parameters - # Remove-Role -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Role" - Write-Host $_.ErrorDetails - } - /roles/bulk-delete: - post: - operationId: deleteBulkRoles - summary: Delete Role(s) - tags: - - Roles - description: |- - This endpoint initiates a bulk deletion of one or more roles. - When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. - This endpoint can only bulk delete up to a limit of 50 roles per request. - A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - roleIds: - description: List of IDs of Roles to be deleted. - type: array - items: - type: string - example: - - 2c9180847812e0b1017817051919ecca - - 2c9180887812e0b201781e129f151816 - required: - - roleIds - example: - roleIds: - - 2c91808876438bb2017668b91919ecca - - 2c91808876438ba801766e129f151816 - responses: - '202': - description: Returns an object with the id of the task performing the delete operation. - content: - application/json: - schema: - type: object - description: Task result. - properties: - type: - type: string - description: Task result DTO type. - enum: - - TASK_RESULT - example: TASK_RESULT - id: - type: string - description: Task result ID. - example: 464ae7bf791e49fdb74606a2e4a89635 - name: - type: string - description: Task result display name. - nullable: true - example: null - example: - type: TASK_RESULT - id: 464ae7bf791e49fdb74606a2e4a89635 - name: null - '400': - description: Client Error - Returned if the request body is invalid. - content: - application/json: - schema: - $ref: '#/paths/~1access-profiles~1%7Bid%7D/delete/responses/400/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ErrorResponseDto.yaml - examples: - 400.1 Bad Request Content: - description: Response for bad request content - value: - detailCode: 400.1 Bad Request Content - trackingId: 1ea1adcb84da4dcb890145e05745774e - messages: - - locale: en-US - localeOrigin: DEFAULT - text: The request was syntactically correct but its content is semantically invalid. - 400.1 Role ids limit violation: - description: Role ids limit violation response - value: - detailCode: 400.1 Bad Request Content - trackingId: 77aa89ac6f0e422dbc588866abc22be9 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: roleIds count exceeded max limit of 50 for bulk-delete. - 400.1.404 Referenced object not found: - description: Referenced object not found response - value: - detailCode: 400.1.404 Referenced object not found - trackingId: 77aa89ac6f0e422dbc588866abc22be9 - messages: - - locale: en-US - localeOrigin: DEFAULT - text: Referenced roleIds ["2c91808876438bb2017668b91919ecca"] was not found. - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:role-unchecked:manage - - idn:role-checked:manage - x-sailpoint-userLevels: - - ORG_ADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/roles#delete-bulk-roles - source: | - $RoleBulkDeleteRequest = @" - { - "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] - } - "@ - - # Delete Role(s) - - try { - $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest - Remove-BulkRoles -RoleBulkDeleteRequest $Result - - # Below is a request that includes all optional parameters - # Remove-BulkRoles -RoleBulkDeleteRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BulkRoles" - Write-Host $_.ErrorDetails - } - /roles/{id}/assigned-identities: - get: - operationId: getRoleAssignedIdentities - tags: - - Roles - summary: List Identities assigned a Role - parameters: - - in: path - name: id - schema: - type: string - description: ID of the Role for which the assigned Identities are to be listed - example: 2c91808a7813090a017814121e121518 - required: true - x-sailpoint-resource-operation-id: listRoles - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml - - in: query - name: filters - schema: - type: string - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **aliasName**: *eq, sw* - - **email**: *eq, sw* - - **name**: *eq, sw, co* - example: name sw Joe - - in: query - name: sorters - schema: - type: string - format: comma-separated - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **id, name, aliasName, email** - example: aliasName,name - responses: - '200': - description: List of Identities assigned the Role - content: - application/json: - schema: - type: array - items: - type: object - description: A subset of the fields of an Identity which is a member of a Role. - properties: - id: - type: string - description: The ID of the Identity - example: 2c9180a46faadee4016fb4e018c20639 - aliasName: - type: string - description: The alias / username of the Identity - example: t.edison - name: - type: string - description: The human-readable display name of the Identity - example: Thomas Edison - email: - type: string - description: Email address of the Identity - example: t.edison@identitynow.com - roleAssignmentSource: - type: string - enum: - - ACCESS_REQUEST - - ROLE_MEMBERSHIP - description: Type which indicates how a particular Identity obtained a particular Role - example: ACCESS_REQUEST - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:role-unchecked:read - - idn:role-unchecked:manage - - idn:role-checked:manage - - idn:role-checked:read - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/roles#get-role-assigned-identities - source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role for which the assigned Identities are to be listed - $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) - $Filters = "name sw Joe" # 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: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) - $Sorters = "aliasName,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) - - # List Identities assigned a Role - - try { - Get-RoleAssignedIdentities -Id $Id - - # Below is a request that includes all optional parameters - # Get-RoleAssignedIdentities -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-RoleAssignedIdentities" - Write-Host $_.ErrorDetails - } - /saved-searches: - post: - security: - - userAuth: - - sp:saved-search:create - tags: - - Saved Search - description: | - Creates a new saved search. - summary: Create a saved search - operationId: createSavedSearch - requestBody: - description: The saved search to persist. - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/SavedSearch/allOf/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/saved/SavedSearchName.yaml - - $ref: '#/components/schemas/SavedSearch/allOf/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/saved/SavedSearchDetail.yaml - required: true - responses: - '201': - description: The persisted saved search. - content: - application/json: - schema: - type: object - allOf: - - type: object - properties: - id: - description: | - The saved search ID. - type: string - example: 0de46054-fe90-434a-b84e-c6b3359d0c64 - owner: - description: | - The owner of the saved search. - $ref: '#/components/schemas/SavedSearch/allOf/0/properties/owner' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/TypedReference.yaml - ownerId: - type: string - description: The ID of the identity that owns this saved search. - example: 2c91808568c529c60168cca6f90c1313 - public: - type: boolean - description: Whether this saved search is visible to anyone but the owner. This field will always be false as there is no way to set a saved search as public at this time. - default: false - example: false - - $ref: '#/components/schemas/SavedSearch/allOf/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/saved/SavedSearchName.yaml - - $ref: '#/components/schemas/SavedSearch/allOf/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/saved/SavedSearchDetail.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/saved-search#create-saved-search - source: | - $CreateSavedSearchRequest = @" - - "@ - - # Create a saved search - - try { - $Result = ConvertFrom-JsonToCreateSavedSearchRequest -Json $CreateSavedSearchRequest - New-SavedSearch -CreateSavedSearchRequest $Result - - # Below is a request that includes all optional parameters - # New-SavedSearch -CreateSavedSearchRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SavedSearch" - Write-Host $_.ErrorDetails - } - get: - security: - - userAuth: - - sp:saved-search:read - tags: - - Saved Search - description: | - Returns a list of saved searches. - summary: A list of Saved Searches - operationId: listSavedSearches - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml - - name: filters - in: query - schema: - type: string - description: |- - 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: - - **owner.id**: *eq* - example: owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8" - responses: - '200': - description: The list of requested saved searches. - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1saved-searches/post/responses/201/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/saved/SavedSearch.yaml - headers: - X-Total-Count: - description: The total result count (returned only if the *count* parameter is specified as *true*). - schema: - type: integer - example: 5 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/saved-search#list-saved-searches - source: | - $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) - $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) - $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) - $Filters = "owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"" # 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: **owner.id**: *eq* (optional) - - # A list of Saved Searches - - try { - Get-SavedSearches - - # Below is a request that includes all optional parameters - # Get-SavedSearches -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SavedSearches" - Write-Host $_.ErrorDetails - } - /saved-searches/{id}: - put: - tags: - - Saved Search - description: | - Updates an existing saved search. - - >**NOTE: You cannot update the `owner` of the saved search.** - summary: | - Updates an existing saved search - operationId: putSavedSearch - parameters: - - in: path - name: id - description: ID of the requested document. - schema: - type: string - required: true - example: 2c91808568c529c60168cca6f90c1313 - x-sailpoint-resource-operation-id: listSavedSearches - requestBody: - description: The saved search to persist. - content: - application/json: - schema: - $ref: '#/paths/~1saved-searches/post/responses/201/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/saved/SavedSearch.yaml - required: true - responses: - '200': - description: The persisted saved search. - content: - application/json: - schema: - $ref: '#/paths/~1saved-searches/post/responses/201/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/saved/SavedSearch.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/saved-search#put-saved-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $SavedSearch = @" - { - "owner" : { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "created" : "2018-06-25T20:22:28.104Z", - "columns" : { - "identity" : [ { - "field" : "displayName", - "header" : "Display Name" - }, { - "field" : "e-mail", - "header" : "Work Email" - } ] - }, - "query" : "@accounts(disabled:true)", - "description" : "Disabled accounts", - "orderBy" : { - "identity" : [ "lastName", "firstName" ], - "role" : [ "name" ] - }, - "sort" : [ "displayName" ], - "filters" : { - "terms" : [ "account_count", "account_count" ], - "range" : { - "lower" : { - "inclusive" : false, - "value" : "1" - }, - "upper" : { - "inclusive" : false, - "value" : "1" - } - }, - "exclude" : false, - "type" : "RANGE" - }, - "ownerId" : "2c91808568c529c60168cca6f90c1313", - "indices" : [ "identities" ], - "public" : false, - "name" : "Disabled accounts", - "modified" : "2018-06-25T20:22:28.104Z", - "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", - "fields" : [ "disabled" ] - } - "@ - - # Updates an existing saved search - - try { - $Result = ConvertFrom-JsonToSavedSearch -Json $SavedSearch - Send-SavedSearch -Id $Id -SavedSearch $Result - - # Below is a request that includes all optional parameters - # Send-SavedSearch -Id $Id -SavedSearch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SavedSearch" - Write-Host $_.ErrorDetails - } - get: - tags: - - Saved Search - description: | - Returns the specified saved search. - summary: Return saved search by ID - operationId: getSavedSearch - parameters: - - in: path - name: id - description: ID of the requested document. - schema: - type: string - required: true - example: 2c91808568c529c60168cca6f90c1313 - x-sailpoint-resource-operation-id: listSavedSearches - responses: - '200': - description: The requested saved search. - content: - application/json: - schema: - $ref: '#/paths/~1saved-searches/post/responses/201/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/saved/SavedSearch.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/saved-search#get-saved-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Return saved search by ID - - try { - Get-SavedSearch -Id $Id - - # Below is a request that includes all optional parameters - # Get-SavedSearch -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SavedSearch" - Write-Host $_.ErrorDetails - } - delete: - tags: - - Saved Search - description: | - Deletes the specified saved search. - summary: Delete document by ID - operationId: deleteSavedSearch - parameters: - - in: path - name: id - description: ID of the requested document. - schema: - type: string - required: true - example: 2c91808568c529c60168cca6f90c1313 - x-sailpoint-resource-operation-id: listSavedSearches - responses: - '204': - description: No Content - Indicates the request was successful but there is no content to be returned in the response. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/saved-search#delete-saved-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Delete document by ID - - try { - Remove-SavedSearch -Id $Id - - # Below is a request that includes all optional parameters - # Remove-SavedSearch -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SavedSearch" - Write-Host $_.ErrorDetails - } - /saved-searches/{id}/execute: - post: - tags: - - Saved Search - description: | - Executes the specified saved search. - summary: Execute a saved search by ID - operationId: executeSavedSearch - parameters: - - in: path - name: id - description: ID of the requested document. - schema: - type: string - required: true - example: 2c91808568c529c60168cca6f90c1313 - x-sailpoint-resource-operation-id: - - listAccessProfiles - - listAccountActivities - - listEntitlements - - listRoles - - listIdentities - requestBody: - description: | - When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. - - If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. - content: - application/json: - schema: - type: object - properties: - scheduleId: - description: | - The ID of the scheduled search that triggered the saved search execution. - type: string - example: 7a724640-0c17-4ce9-a8c3-4a89738459c8 - owner: - description: | - The owner of the scheduled search being tested. - allOf: - - $ref: '#/components/schemas/SavedSearch/allOf/0/properties/owner' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/TypedReference.yaml - recipients: - description: | - The email recipients of the scheduled search being tested. - type: array - items: - $ref: '#/components/schemas/SavedSearch/allOf/0/properties/owner' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/TypedReference.yaml - examples: - scheduled: - summary: Triggered by Scheduled Search - value: - scheduleId: 7a724640-0c17-4ce9-a8c3-4a89738459c8 - test: - summary: Triggered by UI Test - value: - owner: - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - recipients: - - type: IDENTITY - id: 2c91808568c529c60168cca6f90c1313 - required: true - responses: - '202': - description: Accepted - Returned if the request was successfully accepted into the system. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/saved-search#execute-saved-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $SearchArguments = @" - { - "owner" : "", - "recipients" : [ { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } ], - "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" - } - "@ - - # Execute a saved search by ID - - try { - $Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments - Invoke-ExecuteSavedSearch -Id $Id -SearchArguments $Result - - # Below is a request that includes all optional parameters - # Invoke-ExecuteSavedSearch -Id $Id -SearchArguments $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-ExecuteSavedSearch" - Write-Host $_.ErrorDetails - } - /scheduled-searches: - post: - tags: - - Scheduled Search - description: | - Creates a new scheduled search. - summary: Create a new scheduled search - operationId: createScheduledSearch - requestBody: - description: The scheduled search to persist. - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ScheduledSearch/allOf/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/scheduled/ScheduledSearchName.yaml - - $ref: '#/components/schemas/ScheduledSearch/allOf/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/scheduled/SearchSchedule.yaml - examples: - Daily Search: - description: A search that executes each day at a 9 AM - value: - savedSearchId: 9c620e13-cd33-4804-a13d-403bd7bcdbad - schedule: - type: DAILY - hours: - type: LIST - values: - - '9' - recipients: - - type: IDENTITY - id: 2c9180867624cbd7017642d8c8c81f67 - Weekly Search: - description: A search that executes each week on select days and times - value: - savedSearchId: 9c620e13-cd33-4804-a13d-403bd7bcdbad - schedule: - type: WEEKLY - days: - type: LIST - values: - - MON - - TUE - - WED - - THU - - FRI - - SAT - - SUN - hours: - type: LIST - values: - - '9' - recipients: - - type: IDENTITY - id: 2c9180867624cbd7017642d8c8c81f67 - Monthly Search: - description: A search that executes each month on select days and times - value: - savedSearchId: 9c620e13-cd33-4804-a13d-403bd7bcdbad - schedule: - type: MONTHLY - days: - type: LIST - values: - - '1' - - '7' - - '14' - - L - hours: - type: LIST - values: - - '9' - recipients: - - type: IDENTITY - id: 2c9180867624cbd7017642d8c8c81f67 - Annual Search: - description: A search that executes each year on the defined months, days, and times. - value: - savedSearchId: 9c620e13-cd33-4804-a13d-403bd7bcdbad - schedule: - type: ANNUALLY - months: - type: LIST - values: - - '1' - interval: 3 - days: - type: LIST - values: - - '1' - - '7' - - '14' - - L - hours: - type: LIST - values: - - '9' - recipients: - - type: IDENTITY - id: 2c9180867624cbd7017642d8c8c81f67 - Calendar Search: - description: A search that executes on specific calendar days - value: - savedSearchId: 9c620e13-cd33-4804-a13d-403bd7bcdbad - schedule: - type: CALENDAR - days: - type: LIST - values: - - '2023-01-22' - - '2023-02-22' - hours: - type: LIST - values: - - '9' - recipients: - - type: IDENTITY - id: 2c9180867624cbd7017642d8c8c81f67 - required: true - responses: - '201': - description: The persisted scheduled search. - content: - application/json: - schema: - type: object - allOf: - - type: object - properties: - id: - description: The scheduled search ID. - type: string - example: 0de46054-fe90-434a-b84e-c6b3359d0c64 - readOnly: true - owner: - description: The owner of the scheduled search - readOnly: true - type: object - properties: - type: - type: string - description: The type of object being referenced - enum: - - IDENTITY - example: IDENTITY - id: - type: string - description: The ID of the referenced object - example: 2c9180867624cbd7017642d8c8c81f67 - required: - - type - - id - ownerId: - description: | - The ID of the scheduled search owner. - - Please use the `id` in the `owner` object instead. - type: string - example: 2c9180867624cbd7017642d8c8c81f67 - readOnly: true - deprecated: true - - $ref: '#/components/schemas/ScheduledSearch/allOf/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/scheduled/ScheduledSearchName.yaml - - $ref: '#/components/schemas/ScheduledSearch/allOf/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/scheduled/SearchSchedule.yaml - required: - - id - - owner - - ownerId - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#create-scheduled-search - source: | - $CreateScheduledSearchRequest = @" - {savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]} - "@ - - # Create a new scheduled search - - try { - $Result = ConvertFrom-JsonToCreateScheduledSearchRequest -Json $CreateScheduledSearchRequest - New-ScheduledSearch -CreateScheduledSearchRequest $Result - - # Below is a request that includes all optional parameters - # New-ScheduledSearch -CreateScheduledSearchRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ScheduledSearch" - Write-Host $_.ErrorDetails - } - get: - tags: - - Scheduled Search - description: | - Returns a list of scheduled searches. - summary: List scheduled searches - operationId: listScheduledSearch - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml - - name: filters - in: query - schema: - type: string - description: |- - 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: - - **owner.id**: *eq* - - **savedSearchId**: *eq* - example: savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e" - responses: - '200': - description: The list of requested scheduled searches. - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1scheduled-searches/post/responses/201/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/scheduled/ScheduledSearch.yaml - headers: - X-Total-Count: - description: The total result count (returned only if the *count* parameter is specified as *true*). - schema: - type: integer - example: 5 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#list-scheduled-search - source: | - $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) - $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) - $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) - $Filters = "savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"" # 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: **owner.id**: *eq* **savedSearchId**: *eq* (optional) - - # List scheduled searches - - try { - Get-ScheduledSearch - - # Below is a request that includes all optional parameters - # Get-ScheduledSearch -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ScheduledSearch" - Write-Host $_.ErrorDetails - } - /scheduled-searches/{id}: - put: - tags: - - Scheduled Search - description: | - Updates an existing scheduled search. - summary: Update an existing Scheduled Search - operationId: updateScheduledSearch - parameters: - - in: path - name: id - description: ID of the requested document. - schema: - type: string - required: true - example: 2c91808568c529c60168cca6f90c1313 - x-sailpoint-resource-operation-id: listScheduledSearch - requestBody: - description: The scheduled search to persist. - content: - application/json: - schema: - $ref: '#/paths/~1scheduled-searches/post/responses/201/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/scheduled/ScheduledSearch.yaml - required: true - responses: - '200': - description: The persisted scheduled search. - content: - application/json: - schema: - $ref: '#/paths/~1scheduled-searches/post/responses/201/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/scheduled/ScheduledSearch.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#update-scheduled-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $ScheduledSearch = @" - { - "owner" : { - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - }, - "displayQueryDetails" : false, - "created" : "", - "description" : "Daily disabled accounts", - "ownerId" : "2c9180867624cbd7017642d8c8c81f67", - "enabled" : false, - "schedule" : { - "hours" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "months" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "recipients" : [ { - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - }, { - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - } ], - "savedSearchId" : "554f1511-f0a1-4744-ab14-599514d3e57c", - "name" : "Daily disabled accounts", - "modified" : "", - "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", - "emailEmptyResults" : false - } - "@ - - # Update an existing Scheduled Search - - try { - $Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch - Update-ScheduledSearch -Id $Id -ScheduledSearch $Result - - # Below is a request that includes all optional parameters - # Update-ScheduledSearch -Id $Id -ScheduledSearch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ScheduledSearch" - Write-Host $_.ErrorDetails - } - get: - tags: - - Scheduled Search - description: Returns the specified scheduled search. - summary: Get a Scheduled Search - operationId: getScheduledSearch - parameters: - - in: path - name: id - description: ID of the requested document. - schema: - type: string - required: true - example: 2c91808568c529c60168cca6f90c1313 - x-sailpoint-resource-operation-id: listScheduledSearch - responses: - '200': - description: The requested scheduled search. - content: - application/json: - schema: - $ref: '#/paths/~1scheduled-searches/post/responses/201/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/scheduled/ScheduledSearch.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#get-scheduled-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Get a Scheduled Search - - try { - Get-ScheduledSearch -Id $Id - - # Below is a request that includes all optional parameters - # Get-ScheduledSearch -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ScheduledSearch" - Write-Host $_.ErrorDetails - } - delete: - tags: - - Scheduled Search - description: | - Deletes the specified scheduled search. - operationId: deleteScheduledSearch - summary: Delete a Scheduled Search - parameters: - - in: path - name: id - description: ID of the requested document. - schema: - type: string - required: true - example: 2c91808568c529c60168cca6f90c1313 - x-sailpoint-resource-operation-id: listScheduledSearch - responses: - '204': - description: No Content - Indicates the request was successful but there is no content to be returned in the response. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#delete-scheduled-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Delete a Scheduled Search - - try { - Remove-ScheduledSearch -Id $Id - - # Below is a request that includes all optional parameters - # Remove-ScheduledSearch -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ScheduledSearch" - Write-Host $_.ErrorDetails - } - /scheduled-searches/{id}/unsubscribe: - post: - tags: - - Scheduled Search - description: | - Unsubscribes a recipient from the specified scheduled search. - operationId: unsubscribeScheduledSearch - summary: Unsubscribe a recipient from Scheduled Search - parameters: - - $ref: '#/paths/~1saved-searches~1%7Bid%7D~1execute/post/parameters/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/path/search/id.yaml - requestBody: - description: | - The recipient to be removed from the scheduled search. - content: - application/json: - schema: - $ref: '#/components/schemas/SavedSearch/allOf/0/properties/owner' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/TypedReference.yaml - required: true - responses: - '204': - description: No Content - Indicates the request was successful but there is no content to be returned in the response. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#unsubscribe-scheduled-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $TypedReference = @" - { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } - "@ - - # Unsubscribe a recipient from Scheduled Search - - try { - $Result = ConvertFrom-JsonToTypedReference -Json $TypedReference - Invoke-UnsubscribeScheduledSearch -Id $Id -TypedReference $Result - - # Below is a request that includes all optional parameters - # Invoke-UnsubscribeScheduledSearch -Id $Id -TypedReference $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-UnsubscribeScheduledSearch" - Write-Host $_.ErrorDetails - } - /search: - post: - tags: - - Search - description: 'Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. ' - externalDocs: - description: Learn more about search. - url: https://documentation.sailpoint.com/saas/help/search/index.html - operationId: searchPost - security: - - userAuth: - - sp:search:read - - applicationAuth: - - sp:search:read - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - - REPORT_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - - HELPDESK - summary: Perform Search - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml - - in: query - name: limit - description: |- - Max number of results to return. - See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - required: false - example: 10000 - schema: - type: integer - format: int32 - minimum: 0 - maximum: 10000 - default: 250 - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml - requestBody: - content: - application/json: - schema: - type: object - properties: - indices: - description: The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. - externalDocs: - description: Learn more about search indices here. - url: https://documentation.sailpoint.com/saas/help/search/searchable-fields.html - type: array - items: - $ref: '#/components/schemas/SavedSearch/allOf/2/properties/indices/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/Index.yaml - example: - - identities - queryType: - description: |- - The type of query to use. By default, the `SAILPOINT` query type is used, which requires the `query` object to be defined in the request body. - To use the `queryDsl` or `typeAheadQuery` objects in the request, you must set the type to `DSL` or `TYPEAHEAD` accordingly. - Additional values may be added in the future without notice. - type: string - enum: - - DSL - - SAILPOINT - - TEXT - - TYPEAHEAD - default: SAILPOINT - example: SAILPOINT - queryVersion: - allOf: - - description: The current Elasticserver version. - type: string - default: '5.2' - example: '5.2' - - type: string - description: |- - The version of the query object. - This version number will map to the version of Elasticsearch for the query strings and objects being used. - query: - type: object - description: Query parameters used to construct an Elasticsearch query object. - properties: - query: - description: The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. - type: string - example: name:a* - fields: - description: |- - The fields the query will be applied to. Fields provide you with a simple way to add additional fields to search, without making the query too complicated. For example, you can use the fields to specify that you want your query of "a*" to be applied to "name", "firstName", and the "source.name". The response will include all results matching the "a*" query found in those three fields. - A field's availability depends on the indices being searched. For example, if you are searching "identities", you can apply your search to the "firstName" field, but you couldn't use "firstName" with a search on "access profiles". Refer to the response schema for the respective lists of available fields. - type: string - example: - - firstName,lastName,email - timeZone: - description: The time zone to be applied to any range query related to dates. - type: string - example: America/Chicago - innerHit: - type: object - description: Inner Hit query object that will cause the specified nested type to be returned as the result matching the supplied query. - required: - - query - - type - properties: - query: - description: The search query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. - type: string - example: source.name:\"Active Directory\" - type: - description: The nested type to use in the inner hits query. The nested type [Nested Type](https://www.elastic.co/guide/en/elasticsearch/reference/current/nested.html) refers to a document "nested" within another document. For example, an identity can have nested documents for access, accounts, and apps. - type: string - example: access - queryDsl: - description: The search query using the Elasticsearch [Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.10/query-dsl.html) syntax. - type: object - example: - match: - name: john.doe - textQuery: - type: object - description: Query parameters used to construct an Elasticsearch text query object. - required: - - terms - - fields - properties: - terms: - description: Words or characters that specify a particular thing to be searched for. - type: array - items: - type: string - example: - - The quick brown fox - - '3141592' - - '7' - fields: - description: The fields to be searched. - type: array - items: - type: string - example: - - displayName - - employeeNumber - - roleCount - matchAny: - description: Indicates that at least one of the terms must be found in the specified fields; otherwise, all terms must be found. - type: boolean - default: false - example: false - contains: - description: Indicates that the terms can be located anywhere in the specified fields; otherwise, the fields must begin with the terms. - type: boolean - default: false - example: true - typeAheadQuery: - type: object - description: 'Query parameters used to construct an Elasticsearch type ahead query object. The typeAheadQuery performs a search for top values beginning with the typed values. For example, typing "Jo" results in top hits matching "Jo." Typing "Job" results in top hits matching "Job." ' - required: - - query - - field - properties: - query: - description: The type ahead query string used to construct a phrase prefix match query. - type: string - example: Work - field: - description: The field on which to perform the type ahead search. - type: string - example: source.name - nestedType: - description: The nested type. - type: string - example: access - maxExpansions: - description: |- - The number of suffixes the last term will be expanded into. - Influences the performance of the query and the number results returned. - Valid values: 1 to 1000. - type: integer - format: int32 - minimum: 1 - maximum: 1000 - default: 10 - example: 10 - size: - description: The max amount of records the search will return. - type: integer - format: int32 - minimum: 1 - default: 100 - example: 100 - sort: - description: The sort order of the returned records. - type: string - default: desc - example: asc - sortByValue: - description: The flag that defines the sort type, by count or value. - type: boolean - default: false - example: true - includeNested: - description: Indicates whether nested objects from returned search results should be included. - type: boolean - default: true - example: true - queryResultFilter: - type: object - description: Allows the query results to be filtered by specifying a list of fields to include and/or exclude from the result documents. - properties: - includes: - description: The list of field names to include in the result documents. - type: array - items: - type: string - example: - - name - - displayName - excludes: - description: The list of field names to exclude from the result documents. - type: array - items: - type: string - example: - - stacktrace - aggregationType: - description: | - Enum representing the currently available query languages for aggregations, which are used to perform calculations or groupings on search results. - - Additional values may be added in the future without notice. - type: string - enum: - - DSL - - SAILPOINT - default: DSL - example: DSL - aggregationsVersion: - allOf: - - $ref: '#/paths/~1search/post/requestBody/content/application~1json/schema/properties/queryVersion/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/ElasticVersion.yaml - - type: string - description: |- - The version of the language being used for aggregation queries. - This version number will map to the version of Elasticsearch for the aggregation query object. - aggregationsDsl: - description: The aggregation search query using Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) syntax. - type: object - example: {} - aggregations: - allOf: - - type: object - properties: - nested: - type: object - description: The nested aggregation object. - required: - - name - - type - properties: - name: - description: The name of the nested aggregate to be included in the result. - type: string - example: id - type: - description: The type of the nested object. - type: string - example: access - metric: - type: object - description: The calculation done on the results of the query - required: - - name - - field - properties: - name: - description: |- - The name of the metric aggregate to be included in the result. - If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. - type: string - example: Access Name Count - type: - description: |- - Enum representing the currently supported metric aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - COUNT - - UNIQUE_COUNT - - AVG - - SUM - - MEDIAN - - MIN - - MAX - default: UNIQUE_COUNT - example: COUNT - field: - description: | - The field the calculation is performed on. - - Prefix the field name with '@' to reference a nested object. - type: string - example: '@access.name' - filter: - type: object - description: An additional filter to constrain the results of the search query. - required: - - name - - field - - value - properties: - name: - description: The name of the filter aggregate to be included in the result. - type: string - example: Entitlements - type: - description: |- - Enum representing the currently supported filter aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERM - default: TERM - example: TERM - field: - description: | - The search field to apply the filter to. - - Prefix the field name with '@' to reference a nested object. - type: string - example: access.type - value: - description: The value to filter on. - type: string - example: ENTITLEMENT - bucket: - type: object - description: The bucket to group the results of the aggregation query by. - required: - - name - - field - properties: - name: - description: The name of the bucket aggregate to be included in the result. - type: string - example: Identity Locations - type: - description: |- - Enum representing the currently supported bucket aggregation types. - Additional values may be added in the future without notice. - type: string - enum: - - TERMS - default: TERMS - example: TERMS - field: - description: |- - The field to bucket on. - Prefix the field name with '@' to reference a nested object. - type: string - example: attributes.city - size: - description: Maximum number of buckets to include. - type: integer - format: int32 - example: 100 - minDocCount: - description: Minimum number of documents a bucket should have. - type: integer - format: int32 - example: 2 - - type: object - properties: - subAggregation: - allOf: - - $ref: '#/paths/~1search/post/requestBody/content/application~1json/schema/properties/aggregations/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/aggregate/Aggregations.yaml - - type: object - properties: - subAggregation: - description: Aggregation to be performed on the result of the parent bucket aggregation. - $ref: '#/paths/~1search/post/requestBody/content/application~1json/schema/properties/aggregations/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/aggregate/Aggregations.yaml - sort: - description: The fields to be used to sort the search results. Use + or - to specify the sort direction. - type: array - items: - type: string - example: - - displayName - - +id - searchAfter: - description: |- - Used to begin the search window at the values specified. - This parameter consists of the last values of the sorted fields in the current record set. - This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. - It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don't get duplicate results while paging. - For example, when searching for identities, if you are sorting by displayName you will also want to include ID, for example ["displayName", "id"]. - If the last identity ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last displayName is "John Doe", then using that displayName and ID will start a new search after this identity. - The searchAfter value will look like ["John Doe","2c91808375d8e80a0175e1f88a575221"] - type: array - items: - type: string - example: - - John Doe - - 2c91808375d8e80a0175e1f88a575221 - filters: - description: The filters to be applied for each filtered field name. - type: object - additionalProperties: - $ref: '#/components/schemas/SavedSearch/allOf/2/properties/filters/allOf/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/filter/Filter.yaml - example: {} - examples: - accessProfiles: - summary: Query for Access Profiles - value: - indices: - - accessprofiles - query: - query: requestable:true - accountActivities: - summary: Query for Acccount Activities - value: - indices: - - accountactivities - query: - query: sources:"Active Directory" - entitlements: - summary: Query for Entitlements - value: - indices: - - entitlements - query: - query: source.name:Finance - events: - summary: Query for Events - value: - indices: - - events - query: - query: type:PROVISIONING - identities: - summary: Query for Identities - value: - indices: - - identities - query: - query: attributes.cloudLifecycleState:active - roles: - summary: Query for Roles - value: - indices: - - roles - query: - query: enabled:true - query-fields: - summary: Query with Fields - value: - indices: - - identities - query: - query: '"John Doe"' - fields: - - name - query-timeZone: - summary: Query with TimeZone - value: - indices: - - identities - query: - query: 'created: [2022-05-19T19:26:03.351Z TO now]' - timeZone: America/Los_Angeles - query-innerHit: - summary: Query with InnerHit - value: - indices: - - identities - query: - query: '"John Doe"' - innerHit: - type: access - query: source.name:"Active Directory" - typeAheadQuery: - summary: TypeAhead Query - value: - indices: - - identities - queryType: TYPEAHEAD - typeAheadQuery: - field: name - query: Jo - maxExpansions: 50 - size: 100 - sort: desc - sortByValue: false - typeAheadQuery-nestedType: - summary: TypeAhead Query with NestedType - value: - indices: - - identities - queryType: TYPEAHEAD - typeAheadQuery: - field: source.name - nestedType: access - query: Work - maxExpansions: 50 - size: 100 - sort: desc - sortByValue: false - filter-exists: - summary: Filter with Exists - value: - indices: - - identities - query: - query: attributes.city:Austin - filters: - attributes.personalEmail: - type: EXISTS - exclude: true - filter-range: - summary: Filter with Range - value: - indices: - - identities - query: - query: attributes.city:London - timeZone: Europe/London - filters: - accessCount: - type: RANGE - range: - lower: - value: '3' - created: - type: RANGE - range: - lower: - value: '2023-12-01' - inclusive: true - upper: - value: '2025-01-01' - filter-terms: - summary: Filter with Terms - value: - indices: - - identities - query: - query: attributes.city:London - filters: - source.name: - type: TERMS - terms: - - HR Employees - - Corporate Active Directory - exclude: true - isManager: - type: TERMS - terms: - - 'true' - required: true - responses: - '200': - description: List of matching documents. - content: - application/json: - schema: - type: array - items: - type: object - oneOf: - - type: object - allOf: - - $ref: '#/components/schemas/SearchDocument/oneOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/access/profile/AccessProfileDocument.yaml - - type: object - properties: - pod: - type: string - example: pod01-useast1 - description: Name of the pod. - org: - type: string - example: org-name - description: Name of the tenant. - _type: - $ref: '#/paths/~1search/post/responses/200/content/application~1json/schema/items/oneOf/3/allOf/1/properties/_type' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/DocumentType.yaml - type: - $ref: '#/paths/~1search/post/responses/200/content/application~1json/schema/items/oneOf/3/allOf/1/properties/_type' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/DocumentType.yaml - _version: - type: string - example: v2 - description: Version number. - - type: object - allOf: - - $ref: '#/components/schemas/SearchDocument/oneOf/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/account/activity/AccountActivityDocument.yaml - - $ref: '#/paths/~1search/post/responses/200/content/application~1json/schema/items/oneOf/0/allOf/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/DocumentFields.yaml - - type: object - allOf: - - $ref: '#/components/schemas/SearchDocument/oneOf/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/entitlement/EntitlementDocument.yaml - - $ref: '#/paths/~1search/post/responses/200/content/application~1json/schema/items/oneOf/0/allOf/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/DocumentFields.yaml - - type: object - allOf: - - $ref: '#/components/schemas/SearchDocument/oneOf/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/event/EventDocument.yaml - - properties: - pod: - type: string - example: pod01-useast1 - org: - type: string - example: org-name - _type: - description: |- - Enum representing the currently supported document types. - - Additional values may be added in the future without notice. - type: string - enum: - - accessprofile - - accountactivity - - entitlement - - event - - identity - - role - example: identity - _version: - type: string - example: v2 - - type: object - allOf: - - $ref: '#/components/schemas/SearchDocument/oneOf/4' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/identity/IdentityDocument.yaml - - $ref: '#/paths/~1search/post/responses/200/content/application~1json/schema/items/oneOf/0/allOf/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/DocumentFields.yaml - - type: object - allOf: - - $ref: '#/components/schemas/SearchDocument/oneOf/5' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/role/RoleDocument.yaml - - $ref: '#/paths/~1search/post/responses/200/content/application~1json/schema/items/oneOf/0/allOf/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/base/DocumentFields.yaml - examples: - accessProfiles: - summary: A collection of Access Profiles - value: - - id: 13b856dd9a264206954b63ecbb57a853 - name: Cloud Eng - description: Cloud Eng - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - entitlements: - - hasPermissions: false - attribute: memberOf - value: CN=Cloud Engineering,DC=sailpoint,DC=com - schema: group - privileged: false - id: 7372eaddd75749bd89a2e76a363eb891 - name: Cloud Engineering - description: Cloud Engineering - entitlementCount: 1 - segments: [] - segmentCount: 0 - apps: [] - created: '2024-09-16T17:41:25.000Z' - modified: '2024-09-16T19:30:54.000Z' - synced: '2025-02-12T06:32:40.156Z' - enabled: true - requestable: true - requestCommentsRequired: false - owner: - id: ff8081815757d36a015757d42e56031e - name: SailPoint Support - type: IDENTITY - email: cloud-support@sailpoint.com - tags: - - TAG_1 - - TAG_2 - _type: accessprofile - type: accessprofile - pod: pod01-useast1 - org: org-name - _version: v2 - accountActivities: - summary: A collection of Account Activities - value: - - id: 6f76c3add1db4ba8bbe0d42aaceb7a07 - _type: accountactivity - type: accountactivity - requester: - name: Amos.Cunningham - id: ef1e2a36099447cb9448c68e1804dd9f - type: Identity - sources: Active Directory - created: '2025-01-02T21:45:59.795Z' - accountRequests: - - result: - status: committed - accountId: CN=Amos Cunningham,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - op: Modify - provisioningTarget: - name: Active Directory - id: 5c71ff71195b4794a0b87e7cf36fb017 - type: ADLDAPConnector - source: - name: Active Directory - id: 5c71ff71195b4794a0b87e7cf36fb017 - type: ADLDAPConnector - attributeRequests: - - op: Add - name: memberOf - value: CN=HelpDesk,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - stage: Completed - originalRequests: - - result: - status: Manual Task Created - accountId: CN=Amos Cunningham,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - op: Modify - accountUuid: '{17413e85-1c08-4bb0-b658-9afdaad11d0a}' - source: - name: Active Directory - id: 5c71ff71195b4794a0b87e7cf36fb017 - type: ADLDAPConnector - attributeRequests: - - op: Add - name: memberOf - value: CN=HelpDesk,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - expansionItems: [] - approvals: - - owner: - name: tina.smith - id: 322c6bce405a495a8e841a014b7d8410 - type: Identity - result: Finished - attributeRequest: - op: Add - name: memberOf - value: - - CN=HelpDesk,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - accountUuid: '{17413e85-1c08-4bb0-b658-9afdaad11d0a}' - modified: '2025-01-02T21:47:16.903Z' - source: - name: Active Directory - id: 5c71ff71195b4794a0b87e7cf36fb017 - type: ADLDAPConnector - recipient: - name: Amos.Cunningham - id: ef1e2a36099447cb9448c68e1804dd9f - type: Identity - action: Access Request - modified: '2025-01-02T21:47:16.903Z' - trackingNumber: 051d09b0bb5b453d91f658ba7f1e3171 - status: Complete - pod: pod01-useast1 - org: org-name - synced: '2025-01-02T21:47:16.953Z' - _version: v2 - entitlements: - summary: A collection of Entitlements - value: - - id: 2c9180867dde18d1017de8ea1f5c130f - name: Vendor Creation - displayName: Vendor Creation - created: '2021-12-23T20:09:57.340Z' - modified: '2023-05-02T06:31:19.357Z' - attribute: groups - value: VC - sourceSchemaObjectType: group - schema: group - privileged: false - cloudGoverned: false - hash: 22ac1f7a13c8a462c67ee74f5fcbf06a277cce50 - description: Set up new AP vendors - requestable: false - source: - id: 2c9180887de347a7017de8e75fa5570a - type: SOURCE - name: Finance - containsDataAccess: 'false' - pod: pod01-useast1 - org: org-name - synced: '2024-11-07T16:29:06.131Z' - _type: entitlement - type: entitlement - _version: v2 - events: - summary: A collection of Events - value: - - id: 001909ce8cc3b519436197105426b18b5fc6ca179803c0c3702e9038107bec78 - stack: wps - synced: '2023-06-01T22:01:38.170Z' - created: '2023-06-01T22:01:37.818Z' - objects: - - ACCOUNT - type: PROVISIONING - technicalName: ACCOUNT_MODIFY_PASSED - target: - name: Colt.Spears - actor: - name: System - name: Modify Account Passed - action: ModifyAccount - attributes: - accountUuid: '{2d1ec18a-84cc-4659-bf75-a1ce4d56a9c5}' - cloudAppName: Active Directory - appId: 5c71ff71195b4794a0b87e7cf36fb017 - sourceId: source - sourceName: Active Directory - accountName: CN=Colt Spears,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpoint,DC=com - interface: Identity Refresh - trackingNumber: 1f74901adbc0412d9fa51314195155be - operation: MODIFY - status: PASSED - pod: pod01-useast1 - org: org-name - _type: event - _version: v2 - identities: - summary: A collection of Identities - value: - - id: 2c9180865c45e7e3015c46c434a80622 - name: Laura Peeters - firstName: Laura - lastName: Peeters - displayName: Laura Peeters - email: Laura.Peeters@sailpointdemo.com - created: '2024-04-04T21:36:00.385Z' - inactive: false - protected: false - status: ACTIVE - employeeNumber: '10673' - manager: - id: 88e405b1a3b8439daf2efc8f4ff0a98b - name: Mia Garcia - displayName: Mia Garcia - isManager: true - identityProfile: - id: 00a2bc6244b34f4a88d985f035f2b68b - name: HR Global - source: - id: 524f8d986f9b4192865269516d169eb0 - name: HR Global - attributes: - city: Brussels - cloudAuthoritativeSource: 524f8d986f9b4192865269516d169eb0 - cloudLifecycleState: active - cloudStatus: ACTIVE - country: BE - department: EMEA Sales - displayName: Laura Peeters - email: Laura.Peeters@sailpointdemo.com - firstname: Laura - identificationNumber: '10673' - identityState: ACTIVE - internalCloudStatus: ACTIVE - jobTitle: Manager, Sales - Belgium - lastname: Peeters - location: EMEA - uid: '10673' - visibleSegments: - - d75ae486-044b-4eba-8113-0cdacb5341df - disabled: false - locked: false - accounts: - - id: 830396e8863442f1bce7b485612c8b51 - name: Laura Peeters - accountId: '10673' - source: - id: 524f8d986f9b4192865269516d169eb0 - name: HR Global - type: DelimitedFile - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - entitlementAttributes: {} - created: '2024-04-04T21:36:00.385Z' - supportsPasswordChange: false - - id: cd6797419f37492ba22ea991f9d6ba90 - name: $SEK300-N3K0K4HOPEB6 - accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - type: Active Directory - Direct - disabled: false - locked: false - privileged: false - manuallyCorrelated: true - passwordLastSet: '2024-04-04T21:38:57.434Z' - entitlementAttributes: - memberOf: - - CN=Salesforce Access,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - CN=Sales-Folder,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - CN=Salesforce opportunity management,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - created: '2024-04-04T21:42:26.787Z' - supportsPasswordChange: true - - id: db145fd0ec6a4e0cbc3a24bbe0758c8f - name: Laura Peeters - accountId: '10681' - source: - id: 524f8d986f9b4192865269516d169eb0 - name: HR Global - type: DelimitedFile - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - entitlementAttributes: {} - created: '2024-04-04T21:36:15.769Z' - supportsPasswordChange: false - - id: 6b75898eec394b4c98a5c3d2d9ba311b - name: Laura Peeters - accountId: Laura Peeters - source: - id: af4686d6482841ac96d793901372ad9b - name: IdentityNow - type: IdentityNowConnector - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - entitlementAttributes: {} - created: '2024-04-04T21:36:15.809Z' - supportsPasswordChange: true - accountAttributes: {} - accountCount: 3 - apps: - - id: '20003' - name: Active Directory - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: cd6797419f37492ba22ea991f9d6ba90 - accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '20013' - name: AD test - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: cd6797419f37492ba22ea991f9d6ba90 - accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '20014' - name: Test AD - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: cd6797419f37492ba22ea991f9d6ba90 - accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '5092' - name: Accounting - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: cd6797419f37492ba22ea991f9d6ba90 - accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '5822114389092541705' - name: IdentityNow app - source: - id: af4686d6482841ac96d793901372ad9b - name: IdentityNow - account: - id: 6b75898eec394b4c98a5c3d2d9ba311b - accountId: Laura Peeters - appCount: 5 - access: - - id: 4919721c3c1a4ca484469b85f0fd9ba1 - name: Benefits - displayName: Benefits - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - - id: 4bf8f57887874e9c83ae3a662bf8988c - name: Sales-Folder - displayName: Sales-Folder - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Sales-Folder,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - - id: f1bea520cace4489805d26de3463262d - name: Salesforce Access - displayName: Salesforce Access - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Salesforce Access,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - - id: 98a76b26b7884f3e8d115991cebc09b2 - name: Salesforce opportunity management - displayName: Salesforce opportunity management - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Salesforce opportunity management,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - - id: 7e277d102c874560becc464cdfe33a86 - name: Benefits Employees - displayName: Benefits Employees - type: ACCESS_PROFILE - description: Access for Benefits Employees. Distribution group and File share access. - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - owner: - id: 278f8a1859df48d2a0adb204257b26a2 - name: Jerry.Bennett - displayName: Jerry.Bennett - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - - id: 468171f0af874adebb58d3718519bd56 - name: SalesCommonAccess - displayName: SalesCommonAccess - type: ACCESS_PROFILE - description: Grants basic access for everyone in the sale department - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - owner: - id: 278f8a1859df48d2a0adb204257b26a2 - name: Jerry.Bennett - displayName: Jerry.Bennett - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - - id: ad7025c956734455b28fa35e315e77fe - name: Benefits Common Access - displayName: Benefits Common Access - type: ROLE - description: Testing AD provisioning with birthright access - enabled: false - requestable: false - requestCommentsRequired: false - owner: - id: 322c6bce405a495a8e841a014b7d8410 - name: tina.smith - displayName: tina.smith - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - - id: a8819cb0445541438fe08dd38f311b3c - name: SalesGlobal - displayName: SalesGlobal - type: ROLE - description: All Sales people in the company - enabled: false - requestable: false - requestCommentsRequired: false - owner: - id: 29b6ee3f91484d159b1ceac3109af151 - name: se.admin - displayName: se.admin - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - accessCount: 8 - accessProfileCount: 2 - entitlementCount: 4 - roleCount: 2 - modified: '2025-01-17T03:17:17.895Z' - visibleSegments: - - All Employees - visibleSegmentCount: 1 - tagCount: 2 - tags: - - TAG_1 - - TAG_2 - pod: pod01-useast1 - org: org-name - synced: '2025-01-17T06:10:19.853Z' - _type: identity - type: identity - _version: v2 - roles: - summary: A collection of Roles - value: - - id: 2c91808c6faadea6016fb4f2bc69077b - accessProfileCount: 1 - accessProfiles: - - id: 468171f0af874adebb58d3718519bd56 - name: SalesCommonAccess - created: '2023-06-01T22:00:55.311Z' - description: All Sales people in the company - dimensional: false - enabled: true - modified: '2023-06-01T22:00:55.432Z' - name: SalesGlobal - owner: - email: admin@sailpointdemo.com - id: c18630c4811c4030810afb3a14f388cf - name: admin - type: IDENTITY - requestCommentsRequired: false - requestable: true - tags: - - TAG_1 - - TAG_2 - pod: pod01-useast1 - org: org-name - _type: role - type: role - _version: v2 - query-fields: - summary: Query with Fields - value: - - name: John Doe - firstName: John - lastName: Doe - displayName: John Doe - id: 655f6741762547ec937893f27eab0cec - email: John.Doe@sailpointdemo.com - created: '2025-01-03T22:36:20.025Z' - inactive: false - protected: false - status: UNREGISTERED - isManager: false - identityProfile: - id: 63e42f96f2fc4b8ba544654eba6068cf - name: Contractors - source: - id: b33c36dbaf974200b4d91f846abc30a5 - name: Contractors - attributes: - cloudAuthoritativeSource: b33c36dbaf974200b4d91f846abc30a5 - cloudLifecycleState: active - cloudStatus: UNREGISTERED - displayName: John Doe - email: John.Doe@sailpointdemo.com - endDate: '2199-01-01T00:00:00.000Z' - firstname: John - identityState: ACTIVE - internalCloudStatus: UNREGISTERED - lastname: Doe - startDate: '2199-01-01T00:00:00.000Z' - uid: John Doe - visibleSegments: - - d75ae486-044b-4eba-8113-0cdacb5341df - disabled: false - locked: false - accounts: - - id: 6f9cce655ddd40ca86a8faab8d5d52ec - name: John Doe - accountId: ac10e3a8-942a-1409-8194-2e4fe3090003 - source: - id: b33c36dbaf974200b4d91f846abc30a5 - name: Contractors - type: Non-Employee - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - entitlementAttributes: {} - created: '2025-01-03T22:36:20.045Z' - supportsPasswordChange: false - - id: 9e29df88d4c5449ea790b4c24135b85c - name: $FHK300-LAAKDKHU50K3 - accountId: CN=John Doe,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - type: Active Directory - Direct - disabled: false - locked: false - privileged: false - manuallyCorrelated: true - entitlementAttributes: - memberOf: - - CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - created: '2025-01-03T22:36:36.866Z' - supportsPasswordChange: true - - id: 74e0cd14200943ff92b4f11fa3596eba - name: John Doe - accountId: John Doe - source: - id: af4686d6482841ac96d793901372ad9b - name: IdentityNow - type: IdentityNowConnector - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - entitlementAttributes: {} - created: '2025-01-03T22:36:20.076Z' - supportsPasswordChange: true - accountAttributes: {} - accountCount: 2 - apps: - - id: '20003' - name: Active Directory - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: 9e29df88d4c5449ea790b4c24135b85c - accountId: CN=John Doe,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '20013' - name: AD test - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: 9e29df88d4c5449ea790b4c24135b85c - accountId: CN=John Doe,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '20014' - name: Test AD - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: 9e29df88d4c5449ea790b4c24135b85c - accountId: CN=John Doe,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '5092' - name: Accounting - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: 9e29df88d4c5449ea790b4c24135b85c - accountId: CN=John Doe,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '5822114389092541705' - name: IdentityNow app - source: - id: af4686d6482841ac96d793901372ad9b - name: IdentityNow - account: - id: 74e0cd14200943ff92b4f11fa3596eba - accountId: John Doe - appCount: 5 - access: - - id: 4919721c3c1a4ca484469b85f0fd9ba1 - name: Benefits - displayName: Benefits - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - - id: 7e277d102c874560becc464cdfe33a86 - name: Benefits Employees - displayName: Benefits Employees - type: ACCESS_PROFILE - description: Access for Benefits Employees. Distribution group and File share access. - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - owner: - id: 278f8a1859df48d2a0adb204257b26a2 - name: Jerry.Bennett - displayName: Jerry.Bennett - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - - id: ad7025c956734455b28fa35e315e77fe - name: Benefits Common Access - displayName: Benefits Common Access - type: ROLE - description: Testing AD provisioning with birthright access - enabled: false - requestable: false - requestCommentsRequired: false - owner: - id: 322c6bce405a495a8e841a014b7d8410 - name: tina.smith - displayName: tina.smith - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - accessCount: 3 - accessProfileCount: 1 - entitlementCount: 1 - roleCount: 1 - modified: '2025-01-03T22:36:37.599Z' - visibleSegments: - - All Employees - visibleSegmentCount: 1 - tagCount: 0 - pod: pod01-useast1 - org: org-name - synced: '2025-01-03T22:37:04.452Z' - _type: identity - type: identity - _version: v2 - query-timeZone: - summary: Query with TimeZone - value: - - name: Laura Peeters - firstName: Laura - lastName: Peeters - displayName: Laura Peeters - id: 0011cac38db341738af1f2ce7bb3aede - email: Laura.Peeters@sailpointdemo.com - created: '2024-04-04T21:36:00.385Z' - inactive: false - protected: false - status: UNREGISTERED - employeeNumber: '10673' - manager: - id: 88e405b1a3b8439daf2efc8f4ff0a98b - name: Mia Garcia - displayName: Mia Garcia - isManager: true - identityProfile: - id: 00a2bc6244b34f4a88d985f035f2b68b - name: HR Global - source: - id: 524f8d986f9b4192865269516d169eb0 - name: HR Global - attributes: - city: Brussels - cloudAuthoritativeSource: 524f8d986f9b4192865269516d169eb0 - cloudLifecycleState: active - cloudStatus: UNREGISTERED - country: BE - department: EMEA Sales - displayName: Laura Peeters - email: Laura.Peeters@sailpointdemo.com - firstname: Laura - identificationNumber: '10673' - identityState: ACTIVE - internalCloudStatus: UNREGISTERED - jobTitle: Manager, Sales - Belgium - lastname: Peeters - location: EMEA - uid: '10673' - visibleSegments: - - d75ae486-044b-4eba-8113-0cdacb5341df - disabled: false - locked: false - accounts: - - id: 830396e8863442f1bce7b485612c8b51 - name: Laura Peeters - accountId: '10673' - source: - id: 524f8d986f9b4192865269516d169eb0 - name: HR Global - type: DelimitedFile - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - entitlementAttributes: {} - created: '2024-04-04T21:36:00.385Z' - supportsPasswordChange: false - - id: cd6797419f37492ba22ea991f9d6ba90 - name: $SEK300-N3K0K4HOPEB6 - accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - type: Active Directory - Direct - disabled: false - locked: false - privileged: false - manuallyCorrelated: true - passwordLastSet: '2024-04-04T21:38:57.434Z' - entitlementAttributes: - memberOf: - - CN=Salesforce Access,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - CN=Sales-Folder,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - CN=Salesforce opportunity management,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - created: '2024-04-04T21:42:26.787Z' - supportsPasswordChange: true - - id: db145fd0ec6a4e0cbc3a24bbe0758c8f - name: Laura Peeters - accountId: '10681' - source: - id: 524f8d986f9b4192865269516d169eb0 - name: HR Global - type: DelimitedFile - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - entitlementAttributes: {} - created: '2024-04-04T21:36:15.769Z' - supportsPasswordChange: false - - id: 6b75898eec394b4c98a5c3d2d9ba311b - name: Laura Peeters - accountId: Laura Peeters - source: - id: af4686d6482841ac96d793901372ad9b - name: IdentityNow - type: IdentityNowConnector - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - entitlementAttributes: {} - created: '2024-04-04T21:36:15.809Z' - supportsPasswordChange: true - accountAttributes: {} - accountCount: 3 - apps: - - id: '20003' - name: Active Directory - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: cd6797419f37492ba22ea991f9d6ba90 - accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '20013' - name: AD test - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: cd6797419f37492ba22ea991f9d6ba90 - accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '20014' - name: Test AD - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: cd6797419f37492ba22ea991f9d6ba90 - accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '5092' - name: Accounting - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: cd6797419f37492ba22ea991f9d6ba90 - accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '5822114389092541705' - name: IdentityNow app - source: - id: af4686d6482841ac96d793901372ad9b - name: IdentityNow - account: - id: 6b75898eec394b4c98a5c3d2d9ba311b - accountId: Laura Peeters - appCount: 5 - access: - - id: 4919721c3c1a4ca484469b85f0fd9ba1 - name: Benefits - displayName: Benefits - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - - id: 4bf8f57887874e9c83ae3a662bf8988c - name: Sales-Folder - displayName: Sales-Folder - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Sales-Folder,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - - id: f1bea520cace4489805d26de3463262d - name: Salesforce Access - displayName: Salesforce Access - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Salesforce Access,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - - id: 98a76b26b7884f3e8d115991cebc09b2 - name: Salesforce opportunity management - displayName: Salesforce opportunity management - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Salesforce opportunity management,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - - id: 7e277d102c874560becc464cdfe33a86 - name: Benefits Employees - displayName: Benefits Employees - type: ACCESS_PROFILE - description: Access for Benefits Employees. Distribution group and File share access. - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - owner: - id: 278f8a1859df48d2a0adb204257b26a2 - name: Jerry.Bennett - displayName: Jerry.Bennett - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - - id: 468171f0af874adebb58d3718519bd56 - name: SalesCommonAccess - displayName: SalesCommonAccess - type: ACCESS_PROFILE - description: Grants basic access for everyone in the sale department - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - owner: - id: 278f8a1859df48d2a0adb204257b26a2 - name: Jerry.Bennett - displayName: Jerry.Bennett - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - - id: ad7025c956734455b28fa35e315e77fe - name: Benefits Common Access - displayName: Benefits Common Access - type: ROLE - description: Testing AD provisioning with birthright access - enabled: false - requestable: false - requestCommentsRequired: false - owner: - id: 322c6bce405a495a8e841a014b7d8410 - name: tina.smith - displayName: tina.smith - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - - id: a8819cb0445541438fe08dd38f311b3c - name: SalesGlobal - displayName: SalesGlobal - type: ROLE - description: All Sales people in the company - enabled: false - requestable: false - requestCommentsRequired: false - owner: - id: 29b6ee3f91484d159b1ceac3109af151 - name: se.admin - displayName: se.admin - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - accessCount: 8 - accessProfileCount: 2 - entitlementCount: 4 - roleCount: 2 - modified: '2024-12-13T02:49:18.104Z' - visibleSegments: - - All Employees - visibleSegmentCount: 1 - tagCount: 0 - pod: pod01-useast1 - org: org-name - synced: '2024-12-13T06:10:14.229Z' - _type: identity - type: identity - _version: v2 - query-innerHit: - summary: Query with InnerHit - value: - - requestCommentsRequired: false - schema: group - cloudEligible: false - displayName: Benefits - standalone: false - source: - name: Active Directory - id: 5c71ff71195b4794a0b87e7cf36fb017 - type: ENTITLEMENT - enabled: false - privileged: false - name: Benefits - disabled: false - id: 4919721c3c1a4ca484469b85f0fd9ba1 - requestable: false - attribute: memberOf - value: CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - cloudGoverned: false - _type: access - _originalType: identity - _version: v2 - - requestCommentsRequired: false - owner: - displayName: Jerry.Bennett - name: Jerry.Bennett - id: 278f8a1859df48d2a0adb204257b26a2 - cloudEligible: false - displayName: Benefits Employees - standalone: false - description: Access for Benefits Employees. Distribution group and File share access. - source: - name: Active Directory - id: 5c71ff71195b4794a0b87e7cf36fb017 - revocable: false - type: ACCESS_PROFILE - enabled: false - privileged: false - name: Benefits Employees - disabled: false - id: 7e277d102c874560becc464cdfe33a86 - requestable: false - cloudGoverned: false - _type: access - _originalType: identity - _version: v2 - typeAheadQuery: - summary: TypeAhead Query - value: - - Ethan Johnson - - Henry Jones - - Joan.Wells - - Joanna Gonzales - - Joe Cook - - Joe.Myers - - Johan Jacobs - - John Doe - - John Roberts - - John Smith - - John.Jarndyce - - John.Smithee - - John.Williams - - Johnny.Elliott - - Jonathan.West - - Jordan Wilson - - Jordan.Sullivan - - Jose.Reed - - Joao Carvalho - - Kamaria Jones - - Lisa Jones - - Mia Johnson - - Michael Johnson - - Scott Johnson - typeAheadQuery-nestedType: - summary: TypeAhead Query with NestedType - value: - - Active Directory - - PRISM - - ServiceNow - - TRAKK-WS - - AWS - filter-exists: - summary: Filter with Exists - value: - - name: Cory Henry - firstName: Cory - lastName: Henry - displayName: Cory Henry - id: 026bb65ed1f54fcd89197ca986e9acac - email: Cory.Henry@sailpointdemo.com - created: '2024-04-04T21:32:46.844Z' - inactive: false - protected: false - status: UNREGISTERED - employeeNumber: '10090' - manager: - id: 903349b85746471a9a898722206109bb - name: Layla Hendricks - displayName: Layla Hendricks - isManager: true - identityProfile: - id: 00a2bc6244b34f4a88d985f035f2b68b - name: HR Global - source: - id: 524f8d986f9b4192865269516d169eb0 - name: HR Global - attributes: - city: Austin - cloudAuthoritativeSource: 524f8d986f9b4192865269516d169eb0 - cloudLifecycleState: active - cloudStatus: UNREGISTERED - country: US - department: Revenue Operations - displayName: Cory Henry - email: Cory.Henry@sailpointdemo.com - firstname: Cory - identificationNumber: '10090' - identityState: ACTIVE - internalCloudStatus: UNREGISTERED - jobTitle: Manager, System Operations - lastname: Henry - location: AMS - uid: '10090' - visibleSegments: - - d75ae486-044b-4eba-8113-0cdacb5341df - - 8ea4e957-f2f1-4cba-b202-54cc702528d1 - disabled: false - locked: false - accounts: - - id: a02142f41ad1407884da04a7bfa586d4 - name: Cory Henry - accountId: '10090' - source: - id: 524f8d986f9b4192865269516d169eb0 - name: HR Global - type: DelimitedFile - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - entitlementAttributes: {} - created: '2024-04-04T21:32:46.844Z' - supportsPasswordChange: false - - id: f30019e125c74684acee7da3f1643d2a - name: $LUJ300-P3QNVHE6R7FB - accountId: CN=Cory Henry,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - type: Active Directory - Direct - disabled: false - locked: false - privileged: false - manuallyCorrelated: true - passwordLastSet: '2024-04-04T21:33:34.488Z' - entitlementAttributes: - memberOf: - - CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - created: '2024-04-04T21:37:03.481Z' - supportsPasswordChange: true - - id: 7fe340119c5d4b00a9b85d55b18a6416 - name: Cory Henry - accountId: Cory Henry - source: - id: af4686d6482841ac96d793901372ad9b - name: IdentityNow - type: IdentityNowConnector - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - entitlementAttributes: {} - created: '2024-04-04T21:37:03.536Z' - supportsPasswordChange: true - accountAttributes: {} - accountCount: 2 - apps: - - id: '20003' - name: Active Directory - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: f30019e125c74684acee7da3f1643d2a - accountId: CN=Cory Henry,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '20013' - name: AD test - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: f30019e125c74684acee7da3f1643d2a - accountId: CN=Cory Henry,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '20014' - name: Test AD - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: f30019e125c74684acee7da3f1643d2a - accountId: CN=Cory Henry,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '5092' - name: Accounting - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: f30019e125c74684acee7da3f1643d2a - accountId: CN=Cory Henry,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '5822114389092541705' - name: IdentityNow app - source: - id: af4686d6482841ac96d793901372ad9b - name: IdentityNow - account: - id: 7fe340119c5d4b00a9b85d55b18a6416 - accountId: Cory Henry - appCount: 5 - access: - - id: ad7025c956734455b28fa35e315e77fe - name: Benefits Common Access - displayName: Benefits Common Access - type: ROLE - description: Testing AD provisioning with birthright access - enabled: false - requestable: false - requestCommentsRequired: false - owner: - id: 322c6bce405a495a8e841a014b7d8410 - name: tina.smith - displayName: tina.smith - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - - id: 7e277d102c874560becc464cdfe33a86 - name: Benefits Employees - displayName: Benefits Employees - type: ACCESS_PROFILE - description: Access for Benefits Employees. Distribution group and File share access. - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - owner: - id: 278f8a1859df48d2a0adb204257b26a2 - name: Jerry.Bennett - displayName: Jerry.Bennett - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - - id: 4919721c3c1a4ca484469b85f0fd9ba1 - name: Benefits - displayName: Benefits - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - accessCount: 3 - accessProfileCount: 1 - entitlementCount: 1 - roleCount: 1 - modified: '2024-12-13T02:49:19.214Z' - visibleSegments: - - All Employees - - Austin Employees - visibleSegmentCount: 2 - tagCount: 0 - pod: pod01-useast1 - org: org-name - synced: '2024-12-13T06:10:29.734Z' - _type: identity - type: identity - _version: v2 - filter-range: - summary: Filter with Range - value: - - name: Mia Garcia - firstName: Mia - lastName: Garcia - displayName: Mia Garcia - id: 88e405b1a3b8439daf2efc8f4ff0a98b - email: Mia.Garcia@sailpointdemo.com - created: '2024-04-04T21:33:05.522Z' - inactive: false - protected: false - status: UNREGISTERED - employeeNumber: '10142' - manager: - id: 624db52c764f410baca2b192caad8e58 - name: Ethan Johnson - displayName: Ethan Johnson - isManager: true - identityProfile: - id: 00a2bc6244b34f4a88d985f035f2b68b - name: HR Global - source: - id: 524f8d986f9b4192865269516d169eb0 - name: HR Global - attributes: - city: London - cloudAuthoritativeSource: 524f8d986f9b4192865269516d169eb0 - cloudLifecycleState: active - cloudStatus: UNREGISTERED - country: GB - department: EMEA Sales - displayName: Mia Garcia - email: Mia.Garcia@sailpointdemo.com - firstname: Mia - identificationNumber: '10142' - identityState: ACTIVE - internalCloudStatus: UNREGISTERED - jobTitle: Regional Director, EMEA Sales - lastname: Garcia - location: EMEA - uid: '10142' - visibleSegments: - - d75ae486-044b-4eba-8113-0cdacb5341df - disabled: false - locked: false - accounts: - - id: 9021760f10b64f42b7ebfb78085ccaff - name: Mia Garcia - accountId: '10142' - source: - id: 524f8d986f9b4192865269516d169eb0 - name: HR Global - type: DelimitedFile - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - entitlementAttributes: {} - created: '2024-04-04T21:33:05.522Z' - supportsPasswordChange: false - - id: f3ef91f3c2874e79981f2d97297660ee - name: $DUJ300-H5LFRVRDLKKM - accountId: CN=Mia Garcia,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - type: Active Directory - Direct - disabled: false - locked: false - privileged: false - manuallyCorrelated: true - passwordLastSet: '2024-04-04T21:33:25.979Z' - entitlementAttributes: - memberOf: - - CN=Salesforce Access,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - CN=Sales-Folder,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - CN=Salesforce opportunity management,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - created: '2024-04-04T21:36:54.974Z' - supportsPasswordChange: true - - id: c379279cc5b9450cbb274aad31486510 - name: Mia Garcia - accountId: Mia Garcia - source: - id: af4686d6482841ac96d793901372ad9b - name: IdentityNow - type: IdentityNowConnector - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - entitlementAttributes: {} - created: '2024-04-04T21:36:55.027Z' - supportsPasswordChange: true - accountAttributes: {} - accountCount: 2 - apps: - - id: '20003' - name: Active Directory - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: f3ef91f3c2874e79981f2d97297660ee - accountId: CN=Mia Garcia,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '20013' - name: AD test - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: f3ef91f3c2874e79981f2d97297660ee - accountId: CN=Mia Garcia,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '20014' - name: Test AD - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: f3ef91f3c2874e79981f2d97297660ee - accountId: CN=Mia Garcia,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '5092' - name: Accounting - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: f3ef91f3c2874e79981f2d97297660ee - accountId: CN=Mia Garcia,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '5822114389092541705' - name: IdentityNow app - source: - id: af4686d6482841ac96d793901372ad9b - name: IdentityNow - account: - id: c379279cc5b9450cbb274aad31486510 - accountId: Mia Garcia - appCount: 5 - access: - - id: 7e277d102c874560becc464cdfe33a86 - name: Benefits Employees - displayName: Benefits Employees - type: ACCESS_PROFILE - description: Access for Benefits Employees. Distribution group and File share access. - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - owner: - id: 278f8a1859df48d2a0adb204257b26a2 - name: Jerry.Bennett - displayName: Jerry.Bennett - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - - id: 468171f0af874adebb58d3718519bd56 - name: SalesCommonAccess - displayName: SalesCommonAccess - type: ACCESS_PROFILE - description: Grants basic access for everyone in the sale department - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - owner: - id: 278f8a1859df48d2a0adb204257b26a2 - name: Jerry.Bennett - displayName: Jerry.Bennett - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - - id: ad7025c956734455b28fa35e315e77fe - name: Benefits Common Access - displayName: Benefits Common Access - type: ROLE - description: Testing AD provisioning with birthright access - enabled: false - requestable: false - requestCommentsRequired: false - owner: - id: 322c6bce405a495a8e841a014b7d8410 - name: tina.smith - displayName: tina.smith - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - - id: a8819cb0445541438fe08dd38f311b3c - name: SalesGlobal - displayName: SalesGlobal - type: ROLE - description: All Sales people in the company - enabled: false - requestable: false - requestCommentsRequired: false - owner: - id: 29b6ee3f91484d159b1ceac3109af151 - name: se.admin - displayName: se.admin - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - - id: 4919721c3c1a4ca484469b85f0fd9ba1 - name: Benefits - displayName: Benefits - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - - id: 4bf8f57887874e9c83ae3a662bf8988c - name: Sales-Folder - displayName: Sales-Folder - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Sales-Folder,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - - id: f1bea520cace4489805d26de3463262d - name: Salesforce Access - displayName: Salesforce Access - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Salesforce Access,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - - id: 98a76b26b7884f3e8d115991cebc09b2 - name: Salesforce opportunity management - displayName: Salesforce opportunity management - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Salesforce opportunity management,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - accessCount: 8 - accessProfileCount: 2 - entitlementCount: 4 - roleCount: 2 - modified: '2024-12-13T02:49:35.220Z' - visibleSegments: - - All Employees - visibleSegmentCount: 1 - tagCount: 0 - pod: pod01-useast1 - org: org-name - synced: '2024-12-13T06:25:44.222Z' - _type: identity - type: identity - _version: v2 - filter-terms: - summary: Filter with Terms - value: - - name: Oliver Davies - firstName: Oliver - lastName: Davies - displayName: Oliver Davies - id: b173815fef574b74a283f39e6634c215 - email: Oliver.Davies@sailpointdemo.com - created: '2024-04-04T21:32:27.473Z' - inactive: false - protected: false - status: UNREGISTERED - employeeNumber: '10029' - manager: - id: b8c8e021a4104eda91b80bfac6a99b47 - name: Jackson Brooks - displayName: Jackson Brooks - isManager: true - identityProfile: - id: 00a2bc6244b34f4a88d985f035f2b68b - name: HR Global - source: - id: 524f8d986f9b4192865269516d169eb0 - name: HR Global - attributes: - city: London - cloudAuthoritativeSource: 524f8d986f9b4192865269516d169eb0 - cloudLifecycleState: active - cloudStatus: UNREGISTERED - country: GB - department: Customer Support - displayName: Oliver Davies - email: Oliver.Davies@sailpointdemo.com - firstname: Oliver - identificationNumber: '10029' - identityState: ACTIVE - internalCloudStatus: UNREGISTERED - jobTitle: Call Center - lastname: Davies - location: EMEA - uid: '10029' - visibleSegments: - - d75ae486-044b-4eba-8113-0cdacb5341df - disabled: false - locked: false - accounts: - - id: c8cacc7080254b2781f56e0ded6c8dea - name: $GRJ300-AQD2M7N9L7NT - accountId: CN=Oliver Davies,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - type: Active Directory - Direct - disabled: false - locked: false - privileged: false - manuallyCorrelated: true - passwordLastSet: '2024-04-04T21:30:25.205Z' - entitlementAttributes: - memberOf: - - CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - created: '2024-04-04T21:33:54.332Z' - supportsPasswordChange: true - - id: cd7f58b2290c43909320ff89427b57a1 - name: Oliver Davies - accountId: '10029' - source: - id: 524f8d986f9b4192865269516d169eb0 - name: HR Global - type: DelimitedFile - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - entitlementAttributes: {} - created: '2024-04-04T21:32:27.473Z' - supportsPasswordChange: false - - id: a1ee6cd948754371a98105a5a6dd067d - name: Oliver Davies - accountId: Oliver Davies - source: - id: af4686d6482841ac96d793901372ad9b - name: IdentityNow - type: IdentityNowConnector - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - entitlementAttributes: {} - created: '2024-04-04T21:33:54.377Z' - supportsPasswordChange: true - accountAttributes: {} - accountCount: 2 - apps: - - id: '20003' - name: Active Directory - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: c8cacc7080254b2781f56e0ded6c8dea - accountId: CN=Oliver Davies,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '20013' - name: AD test - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: c8cacc7080254b2781f56e0ded6c8dea - accountId: CN=Oliver Davies,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '20014' - name: Test AD - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: c8cacc7080254b2781f56e0ded6c8dea - accountId: CN=Oliver Davies,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '5092' - name: Accounting - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: c8cacc7080254b2781f56e0ded6c8dea - accountId: CN=Oliver Davies,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '5822114389092541705' - name: IdentityNow app - source: - id: af4686d6482841ac96d793901372ad9b - name: IdentityNow - account: - id: a1ee6cd948754371a98105a5a6dd067d - accountId: Oliver Davies - appCount: 5 - access: - - id: ad7025c956734455b28fa35e315e77fe - name: Benefits Common Access - displayName: Benefits Common Access - type: ROLE - description: Testing AD provisioning with birthright access - enabled: false - requestable: false - requestCommentsRequired: false - owner: - id: 322c6bce405a495a8e841a014b7d8410 - name: tina.smith - displayName: tina.smith - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - - id: 7e277d102c874560becc464cdfe33a86 - name: Benefits Employees - displayName: Benefits Employees - type: ACCESS_PROFILE - description: Access for Benefits Employees. Distribution group and File share access. - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - owner: - id: 278f8a1859df48d2a0adb204257b26a2 - name: Jerry.Bennett - displayName: Jerry.Bennett - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - - id: 4919721c3c1a4ca484469b85f0fd9ba1 - name: Benefits - displayName: Benefits - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - accessCount: 3 - accessProfileCount: 1 - entitlementCount: 1 - roleCount: 1 - modified: '2024-12-13T02:49:35.917Z' - visibleSegments: - - All Employees - visibleSegmentCount: 1 - tagCount: 0 - pod: pod01-useast1 - org: org-name - synced: '2024-12-13T06:28:14.763Z' - _type: identity - type: identity - _version: v2 - headers: - X-Total-Count: - schema: - type: integer - description: The total result count (returned only if the *count* parameter is specified as *true*). - example: 30 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/search#search-post - source: | - $Search = @" - { - "queryDsl" : { - "match" : { - "name" : "john.doe" - } - }, - "aggregationType" : "DSL", - "aggregationsVersion" : "", - "query" : { - "query" : "name:a*", - "timeZone" : "America/Chicago", - "fields" : "[firstName,lastName,email]", - "innerHit" : { - "query" : "source.name:\\\"Active Directory\\\"", - "type" : "access" - } - }, - "aggregationsDsl" : { }, - "sort" : [ "displayName", "+id" ], - "filters" : { }, - "queryVersion" : "", - "queryType" : "SAILPOINT", - "includeNested" : true, - "queryResultFilter" : { - "excludes" : [ "stacktrace" ], - "includes" : [ "name", "displayName" ] - }, - "indices" : [ "identities" ], - "typeAheadQuery" : { - "field" : "source.name", - "size" : 100, - "query" : "Work", - "sortByValue" : true, - "nestedType" : "access", - "sort" : "asc", - "maxExpansions" : 10 - }, - "textQuery" : { - "contains" : true, - "terms" : [ "The quick brown fox", "3141592", "7" ], - "matchAny" : false, - "fields" : [ "displayName", "employeeNumber", "roleCount" ] - }, - "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], - "aggregations" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - } - } - "@ - $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) - $Limit = 10000 # 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) - $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) - - # Perform Search - - try { - $Result = ConvertFrom-JsonToSearch -Json $Search - Search-Post -Search $Result - - # Below is a request that includes all optional parameters - # Search-Post -Search $Result -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Post" - Write-Host $_.ErrorDetails - } - /search/count: - post: - tags: - - Search - description: Performs a search with a provided query and returns the count of results in the X-Total-Count header. - operationId: searchCount - security: - - userAuth: - - sp:search:read - summary: Count Documents Satisfying a Query - requestBody: - content: - application/json: - schema: - $ref: '#/paths/~1search/post/requestBody/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/Search.yaml - examples: - query-timeZone: - $ref: '#/paths/~1search/post/requestBody/content/application~1json/examples/query-timeZone' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/examples/query-timeZone.yaml - required: true - responses: - '204': - description: No content - indicates the request was successful but there is no content to be returned in the response. - headers: - X-Total-Count: - description: The total result count. - schema: - type: integer - example: 5 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/search#search-count - source: | - $Search = @" - { - "queryDsl" : { - "match" : { - "name" : "john.doe" - } - }, - "aggregationType" : "DSL", - "aggregationsVersion" : "", - "query" : { - "query" : "name:a*", - "timeZone" : "America/Chicago", - "fields" : "[firstName,lastName,email]", - "innerHit" : { - "query" : "source.name:\\\"Active Directory\\\"", - "type" : "access" - } - }, - "aggregationsDsl" : { }, - "sort" : [ "displayName", "+id" ], - "filters" : { }, - "queryVersion" : "", - "queryType" : "SAILPOINT", - "includeNested" : true, - "queryResultFilter" : { - "excludes" : [ "stacktrace" ], - "includes" : [ "name", "displayName" ] - }, - "indices" : [ "identities" ], - "typeAheadQuery" : { - "field" : "source.name", - "size" : 100, - "query" : "Work", - "sortByValue" : true, - "nestedType" : "access", - "sort" : "asc", - "maxExpansions" : 10 - }, - "textQuery" : { - "contains" : true, - "terms" : [ "The quick brown fox", "3141592", "7" ], - "matchAny" : false, - "fields" : [ "displayName", "employeeNumber", "roleCount" ] - }, - "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], - "aggregations" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - } - } - "@ - - # Count Documents Satisfying a Query - - try { - $Result = ConvertFrom-JsonToSearch -Json $Search - Search-Count -Search $Result - - # Below is a request that includes all optional parameters - # Search-Count -Search $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Count" - Write-Host $_.ErrorDetails - } - /search/aggregate: - post: - tags: - - Search - description: 'Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. ' - operationId: searchAggregate - security: - - userAuth: - - sp:search:read - summary: Perform a Search Query Aggregation - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml - requestBody: - content: - application/json: - schema: - $ref: '#/paths/~1search/post/requestBody/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/Search.yaml - examples: - metricAggregation: - summary: MetricAggregation - value: - indices: - - identities - aggregationType: SAILPOINT - aggregations: - metric: - name: How Many Locations - type: UNIQUE_COUNT - field: attributes.city - metricAggregation-dsl: - summary: MetricAggregation using DSL - value: - indices: - - identities - aggregationType: DSL - aggregationsDsl: - How Many Locations: - cardinality: - field: attributes.city.exact - bucketAggregation: - summary: BucketAggregation - value: - indices: - - identities - aggregationType: SAILPOINT - aggregations: - bucket: - name: Identity Locations - type: TERMS - field: attributes.city - bucketAggregation-dsl: - summary: BucketAggregation using DSL - value: - indices: - - identities - aggregationType: DSL - aggregationsDsl: - Identity Locations: - terms: - field: attributes.city.exact - nestedAggregation-bucketAggregation: - summary: NestedAggregation with BucketAggregation - value: - indices: - - identities - aggregationType: SAILPOINT - aggregations: - nested: - name: Access - field: access - type: TERMS - bucket: - name: Access Source Name - type: TERMS - field: access.source.name - nestedAggregation-bucketAggregation-dsl: - summary: NestedAggregation with BucketAggregation using DSL - value: - indices: - - identities - aggregationType: DSL - aggregationsDsl: - access: - nested: - path: access - aggs: - Access Source Name: - terms: - field: access.source.name.exact - nestedAggregation-filterAggregation-bucketAggregation: - summary: NestedAggregation with FilterAggregation and BucketAggregation - value: - indices: - - identities - aggregationType: SAILPOINT - aggregations: - nested: - name: Access - field: access - type: TERMS - filter: - name: Entitlements - field: access.type - value: ENTITLEMENT - bucket: - name: Access Name - type: TERMS - field: access.name - nestedAggregation-filterAggregation-bucketAggregation-dsl: - summary: NestedAggregation with FilterAggregation and BucketAggregation using DSL - value: - indices: - - identities - aggregationType: DSL - aggregationsDsl: - access: - nested: - path: access - aggs: - Entitlements: - filter: - term: - access.type: ENTITLEMENT - aggs: - Access Name: - terms: - field: access.name.exact - bucketAggregation-subAggregation: - summary: BucketAggregation with SubAggregation - value: - indices: - - identities - aggregationType: SAILPOINT - aggregations: - bucket: - name: Identity Department - type: TERMS - field: attributes.department - subAggregation: - bucket: - name: Identity Locations - type: TERMS - field: attributes.city - bucketAggregation-subAggregation-dsl: - summary: BucketAggregation with SubAggregation using DSL - value: - indices: - - identities - aggregationType: DSL - aggregationsDsl: - Identity Department: - terms: - field: attributes.department.exact - aggs: - Identity Locations: - terms: - field: attributes.city.exact - required: true - responses: - '200': - description: Aggregation results. - content: - application/json: - schema: - type: object - properties: - aggregations: - type: object - description: | - The document containing the results of the aggregation. This document is controlled by Elasticsearch and depends on the type of aggregation query that is run. - - See Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) documentation for information. - example: - Identity Locations: - buckets: - - key: Austin - doc_count: 109 - - key: London - doc_count: 64 - - key: San Jose - doc_count: 27 - - key: Brussels - doc_count: 26 - - key: Sao Paulo - doc_count: 24 - - key: Munich - doc_count: 23 - - key: Singapore - doc_count: 22 - - key: Tokyo - doc_count: 20 - - key: Taipei - doc_count: 16 - hits: - description: | - The results of the aggregation search query. - type: array - items: - $ref: '#/paths/~1search/post/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/documents/SearchDocuments.yaml - text/csv: - schema: - description: | - If the *Accept:text/csv* header is specified and the *aggregationType* parameter in the request body is *SAILPOINT*, - - the aggregation result will be returned as a CSV document. - type: string - example: - - Identity Locations,Count - - Munich,23 - - Brussels,26 - - Singapore,22 - - Tokyo,20 - - Taipei,16 - - London,64 - - Austin,109 - - Sao Paulo,24 - - San Jose,27 - headers: - X-Total-Count: - description: The total result count (returned only if the *count* parameter is specified as *true*). - schema: - type: integer - example: 5 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/search#search-aggregate - source: | - $Search = @" - { - "queryDsl" : { - "match" : { - "name" : "john.doe" - } - }, - "aggregationType" : "DSL", - "aggregationsVersion" : "", - "query" : { - "query" : "name:a*", - "timeZone" : "America/Chicago", - "fields" : "[firstName,lastName,email]", - "innerHit" : { - "query" : "source.name:\\\"Active Directory\\\"", - "type" : "access" - } - }, - "aggregationsDsl" : { }, - "sort" : [ "displayName", "+id" ], - "filters" : { }, - "queryVersion" : "", - "queryType" : "SAILPOINT", - "includeNested" : true, - "queryResultFilter" : { - "excludes" : [ "stacktrace" ], - "includes" : [ "name", "displayName" ] - }, - "indices" : [ "identities" ], - "typeAheadQuery" : { - "field" : "source.name", - "size" : 100, - "query" : "Work", - "sortByValue" : true, - "nestedType" : "access", - "sort" : "asc", - "maxExpansions" : 10 - }, - "textQuery" : { - "contains" : true, - "terms" : [ "The quick brown fox", "3141592", "7" ], - "matchAny" : false, - "fields" : [ "displayName", "employeeNumber", "roleCount" ] - }, - "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], - "aggregations" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - } - } - "@ - $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) - $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) - $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) - - # Perform a Search Query Aggregation - - try { - $Result = ConvertFrom-JsonToSearch -Json $Search - Search-Aggregate -Search $Result - - # Below is a request that includes all optional parameters - # Search-Aggregate -Search $Result -Offset $Offset -Limit $Limit -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Aggregate" - Write-Host $_.ErrorDetails - } - /search/{index}/{id}: - get: - tags: - - Search - description: Fetches a single document from the specified index, using the specified document ID. - operationId: searchGet - security: - - userAuth: - - sp:search:read - - applicationAuth: - - sp:search:read - x-sailpoint-userLevels: - - ORG_ADMIN - - CERT_ADMIN - - REPORT_ADMIN - - SOURCE_ADMIN - - SOURCE_SUBADMIN - - ROLE_ADMIN - - ROLE_SUBADMIN - - HELPDESK - summary: Get a Document by ID - parameters: - - in: path - name: index - description: | - The index from which to fetch the specified document. - - The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. - schema: - type: string - enum: - - accessprofiles - - accountactivities - - entitlements - - events - - identities - - roles - required: true - example: identities - - $ref: '#/paths/~1saved-searches~1%7Bid%7D~1execute/post/parameters/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/path/search/id.yaml - responses: - '200': - description: The requested document. - content: - application/json: - schema: - type: object - oneOf: - - $ref: '#/components/schemas/SearchDocument/oneOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/access/profile/AccessProfileDocument.yaml - - $ref: '#/components/schemas/SearchDocument/oneOf/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/account/activity/AccountActivityDocument.yaml - - $ref: '#/components/schemas/SearchDocument/oneOf/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/entitlement/EntitlementDocument.yaml - - $ref: '#/components/schemas/SearchDocument/oneOf/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/event/EventDocument.yaml - - $ref: '#/components/schemas/SearchDocument/oneOf/4' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/identity/IdentityDocument.yaml - - $ref: '#/components/schemas/SearchDocument/oneOf/5' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/search/model/role/RoleDocument.yaml - examples: - accessProfile: - summary: AccessProfile - value: - id: 13b856dd9a264206954b63ecbb57a853 - name: Cloud Eng - description: Cloud Eng - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - entitlements: - - hasPermissions: false - attribute: memberOf - value: CN=Cloud Engineering,DC=sailpoint,DC=COM - schema: group - privileged: false - id: 7372eaddd75749bd89a2e76a363eb891 - name: Cloud Engineering - description: Cloud Engineering - entitlementCount: 1 - segments: [] - segmentCount: 0 - apps: [] - created: '2024-09-16T17:41:25.000Z' - modified: '2024-09-16T19:30:54.000Z' - synced: '2025-02-12T06:32:40.156Z' - enabled: true - requestable: true - requestCommentsRequired: false - owner: - id: ff8081815757d36a015757d42e56031e - name: SailPoint Support - type: IDENTITY - email: cloud-support@sailpoint.com - tags: - - TAG_1 - - TAG_2 - accountActivity: - summary: AccountActivity - value: - id: 6f76c3add1db4ba8bbe0d42aaceb7a07 - requester: - name: Amos.Cunningham - id: ef1e2a36099447cb9448c68e1804dd9f - type: Identity - synced: '2025-01-02T21:47:16.953Z' - sources: Active Directory - created: '2025-01-02T21:45:59.795Z' - accountRequests: - - result: - status: committed - accountId: CN=Amos Cunningham,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - op: Modify - provisioningTarget: - name: Active Directory - id: 5c71ff71195b4794a0b87e7cf36fb017 - type: ADLDAPConnector - source: - name: Active Directory - id: 5c71ff71195b4794a0b87e7cf36fb017 - type: ADLDAPConnector - attributeRequests: - - op: Add - name: memberOf - value: CN=HelpDesk,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - stage: Completed - originalRequests: - - result: - status: Manual Task Created - accountId: CN=Amos Cunningham,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - op: Modify - accountUuid: '{17413e85-1c08-4bb0-b658-9afdaad11d0a}' - source: - name: Active Directory - id: 5c71ff71195b4794a0b87e7cf36fb017 - type: ADLDAPConnector - attributeRequests: - - op: Add - name: memberOf - value: CN=HelpDesk,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - expansionItems: [] - approvals: - - owner: - name: tina.smith - id: 322c6bce405a495a8e841a014b7d8410 - type: Identity - result: Finished - attributeRequest: - op: Add - name: memberOf - value: - - CN=HelpDesk,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - accountUuid: '{17413e85-1c08-4bb0-b658-9afdaad11d0a}' - modified: '2025-01-02T21:47:16.903Z' - source: - name: Active Directory - id: 5c71ff71195b4794a0b87e7cf36fb017 - type: ADLDAPConnector - recipient: - name: Amos.Cunningham - id: ef1e2a36099447cb9448c68e1804dd9f - type: Identity - action: Access Request - modified: '2025-01-02T21:47:16.903Z' - trackingNumber: 051d09b0bb5b453d91f658ba7f1e3171 - status: Complete - entitlement: - summary: Entitlement - value: - id: 2c9180867dde18d1017de8ea1f5c130f - name: Vendor Creation - displayName: Vendor Creation - created: '2021-12-23T20:09:57.340Z' - modified: '2023-05-02T06:31:19.357Z' - attribute: groups - value: VC - sourceSchemaObjectType: group - schema: group - privileged: false - cloudGoverned: false - hash: 22ac1f7a13c8a462c67ee74f5fcbf06a277cce50 - description: Set up new AP vendors - requestable: false - source: - id: 2c9180887de347a7017de8e75fa5570a - type: SOURCE - name: Finance - containsDataAccess: 'false' - event: - summary: Event - value: - id: 001909ce8cc3b519436197105426b18b5fc6ca179803c0c3702e9038107bec78 - stack: wps - synced: '2023-06-01T22:01:38.170Z' - created: '2023-06-01T22:01:37.818Z' - objects: - - ACCOUNT - type: PROVISIONING - technicalName: ACCOUNT_MODIFY_PASSED - target: - name: Colt.Spears - actor: - name: System - name: Modify Account Passed - action: ModifyAccount - attributes: - accountUuid: '{2d1ec18a-84cc-4659-bf75-a1ce4d56a9c5}' - cloudAppName: Active Directory - appId: 5c71ff71195b4794a0b87e7cf36fb017 - sourceId: source - sourceName: Active Directory - accountName: CN=Colt Spears,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpoint,DC=com - interface: Identity Refresh - trackingNumber: 1f74901adbc0412d9fa51314195155be - operation: MODIFY - status: PASSED - identity: - summary: Identity - value: - id: 2c9180865c45e7e3015c46c434a80622 - name: Laura Peeters - firstName: Laura - lastName: Peeters - displayName: Laura Peeters - email: Laura.Peeters@sailpointdemo.com - created: '2024-04-04T21:36:00.385Z' - inactive: false - protected: false - status: ACTIVE - employeeNumber: '10673' - manager: - id: 88e405b1a3b8439daf2efc8f4ff0a98b - name: Mia Garcia - displayName: Mia Garcia - isManager: true - identityProfile: - id: 00a2bc6244b34f4a88d985f035f2b68b - name: HR Global - source: - id: 524f8d986f9b4192865269516d169eb0 - name: HR Global - attributes: - city: Brussels - cloudAuthoritativeSource: 524f8d986f9b4192865269516d169eb0 - cloudLifecycleState: active - cloudStatus: UNREGISTERED - country: BE - department: EMEA Sales - displayName: Laura Peeters - email: Laura.Peeters@sailpointdemo.com - firstname: Laura - identificationNumber: '10673' - identityState: ACTIVE - internalCloudStatus: UNREGISTERED - jobTitle: Manager, Sales - Belgium - lastname: Peeters - location: EMEA - uid: '10673' - visibleSegments: - - d75ae486-044b-4eba-8113-0cdacb5341df - disabled: false - locked: false - accounts: - - id: 830396e8863442f1bce7b485612c8b51 - name: Laura Peeters - accountId: '10673' - source: - id: 524f8d986f9b4192865269516d169eb0 - name: HR Global - type: DelimitedFile - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - entitlementAttributes: {} - created: '2024-04-04T21:36:00.385Z' - supportsPasswordChange: false - - id: cd6797419f37492ba22ea991f9d6ba90 - name: $SEK300-N3K0K4HOPEB6 - accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - type: Active Directory - Direct - disabled: false - locked: false - privileged: false - manuallyCorrelated: true - passwordLastSet: '2024-04-04T21:38:57.434Z' - entitlementAttributes: - memberOf: - - CN=Salesforce Access,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - CN=Sales-Folder,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - CN=Salesforce opportunity management,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - created: '2024-04-04T21:42:26.787Z' - supportsPasswordChange: true - - id: db145fd0ec6a4e0cbc3a24bbe0758c8f - name: Laura Peeters - accountId: '10681' - source: - id: 524f8d986f9b4192865269516d169eb0 - name: HR Global - type: DelimitedFile - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - entitlementAttributes: {} - created: '2024-04-04T21:36:15.769Z' - supportsPasswordChange: false - - id: 6b75898eec394b4c98a5c3d2d9ba311b - name: Laura Peeters - accountId: Laura Peeters - source: - id: af4686d6482841ac96d793901372ad9b - name: IdentityNow - type: IdentityNowConnector - disabled: false - locked: false - privileged: false - manuallyCorrelated: false - entitlementAttributes: {} - created: '2024-04-04T21:36:15.809Z' - supportsPasswordChange: true - accountAttributes: {} - accountCount: 3 - apps: - - id: '20003' - name: Active Directory - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: cd6797419f37492ba22ea991f9d6ba90 - accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '20013' - name: AD test - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: cd6797419f37492ba22ea991f9d6ba90 - accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '20014' - name: Test AD - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: cd6797419f37492ba22ea991f9d6ba90 - accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '5092' - name: Accounting - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - account: - id: cd6797419f37492ba22ea991f9d6ba90 - accountId: CN=Laura Peeters,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - - id: '5822114389092541705' - name: IdentityNow app - source: - id: af4686d6482841ac96d793901372ad9b - name: IdentityNow - account: - id: 6b75898eec394b4c98a5c3d2d9ba311b - accountId: Laura Peeters - appCount: 5 - access: - - id: 4919721c3c1a4ca484469b85f0fd9ba1 - name: Benefits - displayName: Benefits - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Benefits,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - - id: 4bf8f57887874e9c83ae3a662bf8988c - name: Sales-Folder - displayName: Sales-Folder - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Sales-Folder,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - - id: f1bea520cace4489805d26de3463262d - name: Salesforce Access - displayName: Salesforce Access - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Salesforce Access,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - - id: 98a76b26b7884f3e8d115991cebc09b2 - name: Salesforce opportunity management - displayName: Salesforce opportunity management - type: ENTITLEMENT - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - disabled: false - privileged: false - attribute: memberOf - value: CN=Salesforce opportunity management,OU=Sales,OU=AI,OU=Demo,DC=seri,DC=sailpointdemo,DC=com - standalone: false - cloudEligible: false - cloudGoverned: false - schema: group - - id: 7e277d102c874560becc464cdfe33a86 - name: Benefits Employees - displayName: Benefits Employees - type: ACCESS_PROFILE - description: Access for Benefits Employees. Distribution group and File share access. - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - owner: - id: 278f8a1859df48d2a0adb204257b26a2 - name: Jerry.Bennett - displayName: Jerry.Bennett - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - - id: 468171f0af874adebb58d3718519bd56 - name: SalesCommonAccess - displayName: SalesCommonAccess - type: ACCESS_PROFILE - description: Grants basic access for everyone in the sale department - enabled: false - requestable: false - requestCommentsRequired: false - source: - id: 5c71ff71195b4794a0b87e7cf36fb017 - name: Active Directory - owner: - id: 278f8a1859df48d2a0adb204257b26a2 - name: Jerry.Bennett - displayName: Jerry.Bennett - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - - id: ad7025c956734455b28fa35e315e77fe - name: Benefits Common Access - displayName: Benefits Common Access - type: ROLE - description: Testing AD provisioning with birthright access - enabled: false - requestable: false - requestCommentsRequired: false - owner: - id: 322c6bce405a495a8e841a014b7d8410 - name: tina.smith - displayName: tina.smith - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - - id: a8819cb0445541438fe08dd38f311b3c - name: SalesGlobal - displayName: SalesGlobal - type: ROLE - description: All Sales people in the company - enabled: false - requestable: false - requestCommentsRequired: false - owner: - id: 29b6ee3f91484d159b1ceac3109af151 - name: se.admin - displayName: se.admin - disabled: false - privileged: false - standalone: false - revocable: false - cloudEligible: false - cloudGoverned: false - accessCount: 8 - accessProfileCount: 2 - entitlementCount: 4 - roleCount: 2 - modified: '2025-01-17T03:17:17.895Z' - visibleSegments: - - All Employees - visibleSegmentCount: 1 - tagCount: 2 - tags: - - TAG_1 - - TAG_2 - role: - summary: Role - value: - id: 2c91808c6faadea6016fb4f2bc69077b - accessProfileCount: 1 - accessProfiles: - - id: 468171f0af874adebb58d3718519bd56 - name: SalesCommonAccess - created: '2023-06-01T22:00:55.311Z' - description: All Sales people in the company - dimensional: false - enabled: true - modified: '2023-06-01T22:00:55.432Z' - name: SalesGlobal - owner: - email: admin@sailpointdemo.com - id: c18630c4811c4030810afb3a14f388cf - name: admin - type: IDENTITY - requestCommentsRequired: false - requestable: true - tags: - - TAG_1 - - TAG_2 - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/search#search-get - source: | - $Index = "accessprofiles" # String | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Get a Document by ID - - try { - Search-Get -Index $Index -Id $Id - - # Below is a request that includes all optional parameters - # Search-Get -Index $Index -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Get" - Write-Host $_.ErrorDetails - } - /segments: - post: - operationId: createSegment - security: - - userAuth: - - idn:segment:manage - - applicationAuth: - - idn:segment:manage - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - Segments - summary: Create Segment - description: |- - This API creates a segment. - >**Note:** Segment definitions may take time to propagate to all identities. - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: The segment's ID. - example: 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde - name: - type: string - description: The segment's business name. - example: segment-xyz - created: - type: string - format: date-time - description: The time when the segment is created. - example: '2020-01-01T00:00:00.000000Z' - modified: - type: string - format: date-time - description: The time when the segment is modified. - example: '2020-01-01T00:00:00.000000Z' - description: - type: string - description: The segment's optional description. - example: This segment represents xyz - owner: - type: object - nullable: true - description: The owner of this object. - properties: - type: - type: string - enum: - - IDENTITY - description: Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. - example: IDENTITY - id: - type: string - description: Identity id - example: 2c9180a46faadee4016fb4e018c20639 - name: - type: string - description: Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. - example: support - visibilityCriteria: - allOf: - - type: object - properties: - expression: - type: object - properties: - operator: - type: string - description: Operator for the expression - enum: - - AND - - EQUALS - example: EQUALS - attribute: - type: string - description: Name for the attribute - example: location - nullable: true - value: - type: object - nullable: true - properties: - type: - type: string - description: The type of attribute value - example: STRING - value: - type: string - description: The attribute value - example: Austin - children: - type: array - nullable: true - description: List of expressions - items: - type: object - properties: - operator: - type: string - description: Operator for the expression - enum: - - AND - - EQUALS - example: EQUALS - attribute: - type: string - description: Name for the attribute - example: location - nullable: true - value: - $ref: '#/paths/~1segments/post/requestBody/content/application~1json/schema/properties/visibilityCriteria/allOf/0/properties/expression/properties/value' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Value.yaml - children: - type: string - nullable: true - description: There cannot be anymore nested children. This will always be null. - example: null - example: [] - - nullable: true - active: - type: boolean - description: This boolean indicates whether the segment is currently active. Inactive segments have no effect. - default: false - example: true - responses: - '201': - description: Segment created - content: - application/json: - schema: - $ref: '#/paths/~1segments/post/requestBody/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Segment.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/segments#create-segment - source: | - $Segment = @" - { - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "visibilityCriteria" : { - "expression" : { - "children" : [ ], - "attribute" : "location", - "value" : { - "type" : "STRING", - "value" : "Austin" - }, - "operator" : "EQUALS" - } - }, - "name" : "segment-xyz", - "modified" : "2020-01-01T00:00:00Z", - "description" : "This segment represents xyz", - "active" : true, - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" - } - "@ - - # Create Segment - - try { - $Result = ConvertFrom-JsonToSegment -Json $Segment - New-Segment -Segment $Result - - # Below is a request that includes all optional parameters - # New-Segment -Segment $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Segment" - Write-Host $_.ErrorDetails - } - get: - operationId: listSegments - security: - - userAuth: - - idn:segment:read - - idn:segment:manage - - applicationAuth: - - idn:segment:read - - idn:segment:manage - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - Segments - summary: List Segments - description: 'This API returns a list of all segments. ' - parameters: - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml - responses: - '200': - description: List of all segments - content: - application/json: - schema: - type: array - items: - $ref: '#/paths/~1segments/post/requestBody/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Segment.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/segments#list-segments - source: | - $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 Segments - - try { - Get-Segments - - # Below is a request that includes all optional parameters - # Get-Segments -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Segments" - Write-Host $_.ErrorDetails - } - /segments/{id}: - get: - operationId: getSegment - security: - - userAuth: - - idn:segment:read - - idn:segment:manage - - applicationAuth: - - idn:segment:read - - idn:segment:manage - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - Segments - summary: Get Segment by ID - description: This API returns the segment specified by the given ID. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSegments - description: The segment ID to retrieve. - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '200': - description: Segment - content: - application/json: - schema: - $ref: '#/paths/~1segments/post/requestBody/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Segment.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/segments#get-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. - - # Get Segment by ID - - try { - Get-Segment -Id $Id - - # Below is a request that includes all optional parameters - # Get-Segment -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Segment" - Write-Host $_.ErrorDetails - } - delete: - operationId: deleteSegment - security: - - userAuth: - - idn:segment:manage - - applicationAuth: - - idn:segment:manage - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - Segments - summary: Delete Segment by ID - description: |- - This API deletes the segment specified by the given ID. - >**Note:** that segment deletion may take some time to become effective. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSegments - description: The segment ID to delete. - example: ef38f94347e94562b5bb8424a56397d8 - responses: - '204': - description: No content. - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/segments#delete-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. - - # Delete Segment by ID - - try { - Remove-Segment -Id $Id - - # Below is a request that includes all optional parameters - # Remove-Segment -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Segment" - Write-Host $_.ErrorDetails - } - patch: - operationId: patchSegment - security: - - userAuth: - - idn:segment:manage - - applicationAuth: - - idn:segment:manage - x-sailpoint-userLevels: - - ORG_ADMIN - tags: - - Segments - summary: Update Segment - description: |- - Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - >**Note:** Changes to a segment may take some time to propagate to all identities. - parameters: - - in: path - name: id - schema: - type: string - required: true - x-sailpoint-resource-operation-id: listSegments - description: The segment ID to modify. - example: ef38f94347e94562b5bb8424a56397d8 - requestBody: - required: true - description: | - A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - The following fields are patchable: - * name - * description - * owner - * visibilityCriteria - * active - content: - application/json-patch+json: - schema: - type: array - items: - type: object - examples: - Set Visibility Criteria: - description: Set the visibility criteria - value: - - op: replace - path: /visibilityCriteria - value: - expression: - operator: AND - children: - - operator: EQUALS - attribute: location - value: - type: STRING - value: Philadelphia - - operator: EQUALS - attribute: department - value: - type: STRING - value: HR - responses: - '200': - description: Indicates the PATCH operation succeeded, and returns the segment's new representation. - content: - application/json: - schema: - $ref: '#/paths/~1segments/post/requestBody/content/application~1json/schema' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/Segment.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/segments#patch-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to modify. - $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - $RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ - - - # Update Segment - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-Segment -Id $Id -RequestBody $Result - - # Below is a request that includes all optional parameters - # Update-Segment -Id $Id -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Segment" - Write-Host $_.ErrorDetails - } - /service-desk-integrations: - get: - tags: - - Service Desk Integration - summary: List existing Service Desk integrations - description: Get a list of Service Desk integration objects. - operationId: getServiceDeskIntegrations - parameters: - - $ref: '#/paths/~1access-profiles/get/parameters/2' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml - - $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/limit.yaml - - name: sorters - in: query - required: false - style: form - explode: true - schema: - type: string - description: |- - Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) - - Sorting is supported for the following fields: **name** - example: name - - name: filters - in: query - required: false - style: form - explode: true - schema: - type: string - format: comma-separated - description: |- - Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) - - Filtering is supported for the following fields and operators: - - **id**: *eq, in* - - **name**: *eq* - - **type**: *eq, in* - - **cluster**: *eq, in* - example: name eq "John Doe" - - $ref: '#/paths/~1access-profiles/get/parameters/3' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/count.yaml - responses: - '200': - description: List of ServiceDeskIntegrationDto - content: - application/json: - schema: - type: array - items: - allOf: - - type: object - description: Service Desk integration's specification. - required: - - name - - description - - type - - attributes - properties: - id: - type: string - description: Unique identifier for the Service Desk integration - example: 62945a496ef440189b1f03e3623411c8 - name: - description: Service Desk integration's name. The name must be unique. - type: string - example: Service Desk Integration Name - created: - type: string - format: date-time - description: The date and time the Service Desk integration was created - example: '2024-01-17T18:45:25.994Z' - modified: - type: string - format: date-time - description: The date and time the Service Desk integration was last modified - example: '2024-02-18T18:45:25.994Z' - description: - description: Service Desk integration's description. - type: string - example: A very nice Service Desk integration - type: - description: | - Service Desk integration types: - - - ServiceNowSDIM - - ServiceNow - type: string - default: ServiceNowSDIM - example: ServiceNowSDIM - ownerRef: - allOf: - - $ref: '#/components/schemas/ServiceDeskIntegrationDto/allOf/0/properties/ownerRef/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/OwnerDto.yaml - clusterRef: - allOf: - - $ref: '#/components/schemas/ServiceDeskIntegrationDto/allOf/0/properties/clusterRef/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/SourceClusterDto.yaml - cluster: - description: Cluster ID for the Service Desk integration (replaced by clusterRef, retained for backward compatibility). - type: string - example: xyzzy999 - deprecated: true - nullable: true - managedSources: - description: Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility). - type: array - items: - type: string - deprecated: true - example: - - 2c9180835d191a86015d28455b4a2329 - - 2c5680835d191a85765d28455b4a9823 - provisioningConfig: - description: The 'provisioningConfig' property specifies the configuration used to provision integrations. - $ref: '#/components/schemas/ServiceDeskIntegrationDto/allOf/0/properties/provisioningConfig' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ProvisioningConfig.yaml - attributes: - description: Service Desk integration's attributes. Validation constraints enforced by the implementation. - type: object - additionalProperties: true - example: - property: value - key: value - beforeProvisioningRule: - allOf: - - $ref: '#/components/schemas/ServiceDeskIntegrationDto/allOf/0/properties/beforeProvisioningRule/allOf/0' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/BeforeProvisioningRuleDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:service-desk-integration:read - - idn:service-desk-integration:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#get-service-desk-integrations - source: | - $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) - $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) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - $Filters = "name eq "John Doe"" # 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: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) - $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 existing Service Desk integrations - - try { - Get-ServiceDeskIntegrations - - # Below is a request that includes all optional parameters - # Get-ServiceDeskIntegrations -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegrations" - Write-Host $_.ErrorDetails - } - post: - tags: - - Service Desk Integration - summary: Create new Service Desk integration - description: Create a new Service Desk integration. - operationId: createServiceDeskIntegration - requestBody: - description: The specifics of a new integration to create - content: - application/json: - schema: - $ref: '#/paths/~1service-desk-integrations/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ServiceDeskIntegrationDto.yaml - required: true - responses: - '200': - description: Details of the created integration - content: - application/json: - schema: - $ref: '#/paths/~1service-desk-integrations/get/responses/200/content/application~1json/schema/items' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/ServiceDeskIntegrationDto.yaml - '400': - $ref: '#/paths/~1access-profiles/get/responses/400' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml - '401': - $ref: '#/paths/~1access-profiles/get/responses/401' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml - '403': - $ref: '#/paths/~1access-profiles/get/responses/403' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml - '404': - $ref: '#/paths/~1access-requests~1cancel/post/responses/404' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml - '429': - $ref: '#/paths/~1access-profiles/get/responses/429' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml - '500': - $ref: '#/paths/~1access-profiles/get/responses/500' - x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml - security: - - userAuth: - - idn:service-desk-integration:manage - x-sailpoint-userLevels: - - ORG_ADMIN - x-codeSamples: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#create-service-desk-integration - source: | - $ServiceDeskIntegrationDto = @" - { - "ownerRef" : "", - "cluster" : "xyzzy999", - "created" : "2024-01-17T18:45:25.994Z", - "description" : "A very nice Service Desk integration", - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n